scilab/modules/xcos/help/en_US/palettes/Demonstrationsblocks_pal/PDE.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scicos
   4  *
   5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
   6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  *
  22  * See the file ./license.txt
  23  -->
  24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="PDE">
  25     <refnamediv>
  26         <refname>PDE</refname>
  27         <refpurpose>1D PDE block</refpurpose>
  28     </refnamediv>
  29     <refsection>
  30         <title>Block Screenshot</title>
  31         <para>
  32             <inlinemediaobject>
  33                 <imageobject>
  34                     <imagedata fileref="../../../../images/palettes/PDE.png" align="center" valign="middle"/>
  35                 </imageobject>
  36             </inlinemediaobject>
  37         </para>
  38     </refsection>
  39     <refsection id="Contents_PDE">
  40         <title>Contents</title>
  41         <itemizedlist>
  42             <listitem>
  43                 <para>
  44                     <link linkend="PDE">1D PDE block</link>
  45                 </para>
  46             </listitem>
  47             <listitem>
  48                 <itemizedlist>
  49                     <listitem>
  50                         <para>
  51                             <xref linkend="Palette_PDE">Palette</xref>
  52                         </para>
  53                     </listitem>
  54                     <listitem>
  55                         <para>
  56                             <xref linkend="Description_PDE">Description</xref>
  57                         </para>
  58                     </listitem>
  59                     <listitem>
  60                         <para>
  61                             <xref linkend="Dialogbox_PDE">Dialog box</xref>
  62                         </para>
  63                     </listitem>
  64                     <listitem>
  65                         <para>
  66                             <xref linkend="Defaultproperties_PDE">Default properties</xref>
  67                         </para>
  68                     </listitem>
  69                     <listitem>
  70                         <para>
  71                             <xref linkend="Interfacingfunction_PDE">Interfacing function</xref>
  72                         </para>
  73                     </listitem>
  74                 </itemizedlist>
  75             </listitem>
  76         </itemizedlist>
  77     </refsection>
  78     <refsection id="Palette_PDE">
  79         <title>Palette</title>
  80         <itemizedlist>
  81             <listitem>
  82                 <para>
  83                     <link linkend="Demonstrationsblocks_pal">Demonstrations blocks palette</link>
  84                 </para>
  85             </listitem>
  86         </itemizedlist>
  87     </refsection>
  88     <refsection id="Description_PDE">
  89         <title>Description</title>
  90         <para>
  91             This block is an implementation of several numerical schemes (Finite Elements (1st and 2nd order),
  92             Finite Differences (1st and 2nd order), Finite Volumes (1st order)) to solve mono-dimensional
  93             PDE (Partial Differential Equation) within Xcos.
  94             The mathematical framework is restricted to PDEs linear scalars with maximum order 2 in time and space.
  95             The goal is to provide engineers and physicists with an easy-to-use toolbox in Xcos that will let them
  96             graphically describe the PDE to be solved. A decision system selects the most efficient numerical scheme
  97             depending on the type of the PDE and runs the solver.
  98         </para>
  99     </refsection>
 100     <refsection id="Dialogbox_PDE">
 101         <title>Dialog box</title>
 102         <para>
 103             <inlinemediaobject>
 104                 <imageobject>
 105                     <imagedata fileref="../../../../images/gui/PDE_gui.gif" align="center" valign="middle"/>
 106                 </imageobject>
 107             </inlinemediaobject>
 108         </para>
 109         <para>
 110
 111         </para>
 112         <itemizedlist>
 113             <listitem>
 114                 <para>
 115                     <emphasis role="bold">Domain</emphasis>
 116                 </para>
 117                 <para> a and b : (double) The two edges of the discretization field.</para>
 118             </listitem>
 119             <listitem>
 120                 <para>
 121                     <emphasis role="bold">PDE specification</emphasis>
 122                 </para>
 123                 <itemizedlist>
 124                     <listitem>
 125                         Check boxes to select the PDE operators.
 126                         ai(x), bi(t) (i=1:7) are the operator coefficients.
 127                     </listitem>
 128                     <listitem>
 129                         Discriminant type : constant or variable, in the
 130                         later case, the sign should be given.
 131                     </listitem>
 132                 </itemizedlist>
 133             </listitem>
 134             <listitem>
 135                 <para>
 136                     <emphasis role="bold">Discretization method</emphasis>
 137                 </para>
 138                 <itemizedlist>
 139                     <listitem>
 140                         Choice (check box) : is the choice for the manual or the automatic mode.
 141                     </listitem>
 142                     <listitem>
 143                         Type : in the manual mode we can give the method type
 144                         (Finite differences, finite elements or finite volumes).
 145                     </listitem>
 146                     <listitem>
 147                         Degree : method degree (1 or 2 for the FD and FE methods,
 148                         1 for the FV method).
 149                     </listitem>
 150                     <listitem>
 151                         Number of nodes : to give the number of the nodal points.
 152                     </listitem>
 153                 </itemizedlist>
 154             </listitem>
 155             <listitem>
 156                 <para>
 157                     <emphasis role="bold">Initial Conditions</emphasis>
 158                 </para>
 159                 <para> u(x,t0)=, du/dt at t0= : to give the initial conditions. </para>
 160             </listitem>
 161             <listitem>
 162                 <para>
 163                     <emphasis role="bold">Boundary condition on a</emphasis>
 164                 </para>
 165                 <itemizedlist>
 166                     <listitem>
 167                         Type : two types of boundary conditions are possible : Dirichlet or Neumann.
 168                     </listitem>
 169                     <listitem>
 170                         Expression : to give the boundary conditions expression.
 171                     </listitem>
 172                 </itemizedlist>
 173             </listitem>
 174             <listitem>
 175                 <para>
 176                     <emphasis role="bold">Measurement points</emphasis>
 177                 </para>
 178                 <para> To give the list of measurement points. </para>
 179             </listitem>
 180             <listitem>
 181                 <para>
 182                     <emphasis role="bold">Name</emphasis>
 183                 </para>
 184                 <para> A getvalue box to give the block's name. </para>
 185             </listitem>
 186         </itemizedlist>
 187     </refsection>
 188     <refsection id="Defaultproperties_PDE">
 189         <title>Default properties</title>
 190         <itemizedlist>
 191             <listitem>
 192                 <para>
 193                     <emphasis role="bold">always active:</emphasis> yes
 194                 </para>
 195             </listitem>
 196             <listitem>
 197                 <para>
 198                     <emphasis role="bold">direct-feedthrough:</emphasis> no
 199                 </para>
 200             </listitem>
 201             <listitem>
 202                 <para>
 203                     <emphasis role="bold">zero-crossing:</emphasis> no
 204                 </para>
 205             </listitem>
 206             <listitem>
 207                 <para>
 208                     <emphasis role="bold">mode:</emphasis> no
 209                 </para>
 210             </listitem>
 211             <listitem>
 212                 <para>
 213                     <emphasis role="bold">regular inputs:</emphasis>
 214                 </para>
 215                 <para>
 216                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 217                 </para>
 218                 <para>
 219                     <emphasis role="bold">- port 2 : size [1,1] / type 0</emphasis>
 220                 </para>
 221                 <para>
 222                     <emphasis role="bold">- port 3 : size [1,1] / type 0</emphasis>
 223                 </para>
 224                 <para>
 225                     <emphasis role="bold">- port 4 : size [1,1] / type 0</emphasis>
 226                 </para>
 227                 <para>
 228                     <emphasis role="bold">- port 5 : size [1,1] / type 1</emphasis>
 229                 </para>
 230             </listitem>
 231             <listitem>
 232                 <para>
 233                     <emphasis role="bold">regular outputs:</emphasis>
 234                 </para>
 235                 <para>
 236                     <emphasis role="bold">- port 1 : size [10,1] / type 1</emphasis>
 237                 </para>
 238                 <para>
 239                     <emphasis role="bold">- port 2 : size [0,1] / type 1</emphasis>
 240                 </para>
 241             </listitem>
 242             <listitem>
 243                 <para>
 244                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 245                 </para>
 246             </listitem>
 247             <listitem>
 248                 <para>
 249                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 250                 </para>
 251             </listitem>
 252             <listitem>
 253                 <para>
 254                     <emphasis role="bold">continuous-time state:</emphasis> yes
 255                 </para>
 256             </listitem>
 257             <listitem>
 258                 <para>
 259                     <emphasis role="bold">discrete-time state:</emphasis> no
 260                 </para>
 261             </listitem>
 262             <listitem>
 263                 <para>
 264                     <emphasis role="bold">object discrete-time state:</emphasis> no
 265                 </para>
 266             </listitem>
 267             <listitem>
 268                 <para>
 269                     <emphasis role="bold">name of computational function:</emphasis>
 270                     <emphasis role="italic">PDE</emphasis>
 271                 </para>
 272             </listitem>
 273         </itemizedlist>
 274     </refsection>
 275     <refsection id="Interfacingfunction_PDE">
 276         <title>Interfacing function</title>
 277         <itemizedlist>
 278             <listitem>
 279                 <para> SCI/modules/scicos_blocks/macros/PDE/PDE.sci</para>
 280             </listitem>
 281         </itemizedlist>
 282     </refsection>
 283     <refsection id="Computationalfunction_PDE">
 284         <title>Computational functions</title>
 285         <itemizedlist>
 286             <listitem>
 287                 <para> SCI/modules/scicos_blocks/macros/PDE/</para>
 288             </listitem>
 289         </itemizedlist>
 290     </refsection>
 291 </refentry>