Mercurial > fem-fenics-eugenio

comparison doc/API/Function.tex @ 195:0316c1ac91e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Tex file for the API interface.
author gedeone-octave <marcovass89@hotmail.it>
date Sun, 01 Dec 2013 16:47:18 +0000
parents
children e25bc21ab4ff
comparison
equal deleted inserted replaced
194:c29ac833819f 195:0316c1ac91e1
1 % This file was converted from HTML to LaTeX with
2 % gnuhtml2latex program
3 % (c) Tomasz Wegrzanowski <maniek@beer.com> 1999
4 % (c) Gunnar Wolf <gwolf@gwolf.org> 2005-2010
5 % Version : 0.4.
6
7
8 \par Function File: [\textit{func}] \textbf{=}\textit{ Function }(\textit{name, FunctionSpace }(\textit{or Function})\textit{,Vector }(\textit{or index}))\textit{}\\
9 \begin{quotation}\par Initialize an object with the values specified in a vector or extracting a component from a vectorial field.
10 This function can be used in two different ways
11 \begin{itemize}
12 \item To create a function from a vector. In this case, the arguments are:
13 \begin{itemize}
14 \item \textit{name} is a string representing the name of the function
15 \item \textit{FunctionSpace} is the fem-fenics function space where the vector is defined
16 \item \textit{Vector} specifies the values of the coefficientsfor each basisc function of the \textit{FunctioSpace}
17 \end{itemize}
18 \item To extract a scalar field from a vectorial one
19 \begin{itemize}
20 \item \textit{name} is a string representing the name of the function
21 \item \textit{Function} is the vector valued Function
22 \item \textit{Index} contains the index of the scalar field to extract.Index starts from 1.
23 \end{itemize}
24 \end{itemize}
25 The output \textit{func} is an object which contains a representation of the function \textit{Vector} which can be plotted or saved or passed as argument for a variational problem.
26
27 \par \textbf{See also:} Constant, Expression, plot, save.
28
29 \end{quotation}
30