Mercurial > fem-fenics-eugenio

annotate doc/API/assemble.tex @ 197:e25bc21ab4ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix errors in the documentation.
author gedeone-octave <marcovass89@hotmail.it>
date Thu, 19 Dec 2013 09:42:38 +0100
parents 0316c1ac91e1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
195
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
1 % This file was converted from HTML to LaTeX with
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
2 % gnuhtml2latex program
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
3 % (c) Tomasz Wegrzanowski <maniek@beer.com> 1999
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
4 % (c) Gunnar Wolf <gwolf@gwolf.org> 2005-2010
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
5 % Version : 0.4.
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
6
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
7 \par Function File: [\textit{A}], [\textit{x}(Optional)] \textbf{=}\textit{ assemble }(\textit{form\_a, DirichletBC})\textit{}\\
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
8 \begin{quotation}\par Construct the discretization of a Form and apply essential BC.
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
9 The input arguments are
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
10 \begin{itemize}
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
11 \item \textit{form\_a} which is the form to assemble.
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
12 It can be a form of rank 2 (BilinearForm or JacobianForm), a form of rank 1 (LinearForm or ResidualForm) or a form of rank 0 (Functional).
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
13 \item \textit{DirichletBC} represents the optional BC applied to the system.
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
14 \end{itemize}
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
15 The output \textit{A} is a discretized representation of the \textit{form\_a}:
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
16 \begin{itemize}
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
17 \item \textit{A} is a sparse Matrix if \textit{form\_a} is a bilinear form
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
18 \item \textit{A} is a Vector if \textit{form\_a} is a linear form
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
19 \item \textit{A} is a Double if \textit{form\_a} is a functional
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
20 \end{itemize}
197
e25bc21ab4ff Fix errors in the documentation.
gedeone-octave <marcovass89@hotmail.it>
parents: 195
diff changeset
21 If a boundary condition has to be applied to a vector for a nonlinear problem then it should be provided as 2nd argument and it will be given back as the second output argument. For an example of this situation, please refer to the HyperElasticity example.
195
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
22
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
23 \par \textbf{See also:} BilinearForm, LinearForm, ResidualForm, JacobianForm, Functional.
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
24
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
25 \end{quotation}
0316c1ac91e1 Tex file for the API interface.
gedeone-octave <marcovass89@hotmail.it>
parents:
diff changeset
26