Mercurial > fem-fenics-eugenio
changeset 182:b40f22aad4af
Improve the documentation for the pkg release.
author | gedeone-octave <marcovass89@hotmail.it> |
---|---|
date | Fri, 08 Nov 2013 00:29:56 +0000 |
parents | 0de6ca5e31a2 |
children | 536ee96a8cd0 |
files | inst/Constant.m src/DirichletBC.cc src/Expression.cc src/Function.cc |
diffstat | 4 files changed, 36 insertions(+), 25 deletions(-) [+] |
line wrap: on
line diff
--- a/inst/Constant.m Fri Nov 08 00:05:33 2013 +0000 +++ b/inst/Constant.m Fri Nov 08 00:29:56 2013 +0000 @@ -14,9 +14,14 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {c} = Constant (name, value(s)) -## This function take as input the name of the Constant that you want to create -## and the value, which can be either a scalar or a vector. +## @deftypefn {Function File} {[@var{c}]} = Constant (@var{name}, @var{value}) +## +## Creates a constatnt object over all the mesh elements with the value +## specified. +## +## This function take as input the @var{name} of the Constant that has +## to be created and its @var{value}, which can be either a scalar or a vector. +## ## @seealso{Expression, Function} ## @end deftypefn
--- a/src/DirichletBC.cc Fri Nov 08 00:05:33 2013 +0000 +++ b/src/DirichletBC.cc Fri Nov 08 00:29:56 2013 +0000 @@ -22,18 +22,19 @@ DEFUN_DLD (DirichletBC, args, , "-*- texinfo -*-\n\ @deftypefn {Function File} {[@var{bc}]} = \ -DirichletBC (@var{Functional Space}, @var{Boundary Label},\ - @var{Function handle}) \n\ +DirichletBC (@var{FunctionSpace}, @var{Boundary_Label},\ + @var{Function_handle}) \n\ +Specify essential boundary condition on a specific side.\n\ The input parameters are\n\ @itemize @bullet \n\ -@item @var{Functional Space} is a fem-fenics functional space where\ +@item @var{FunctionSpace} is the fem-fenics space where \ we want to apply the BC\n\ -@item @var{Function handle} is a function handle which contains the expression\ -that we want to apply as BC. If we have a Vector field, we can just use a\n\ -vector of function handle: \ -@var{Function handle} = ['@'(x, y) f1, '@'(x, y) f2, ...]\n\ -@item @var{Boundary} is an Array which contains the labels of the \ -sides where the BC is applied\n\ +@item @var{Function_handle} is a function handle which contains the expression \ +that we want to apply as a BC. If we have a Vector field, we can just use a\n\ +vector of function handles: \ +@var{Function handle} = [''@''(x, y) f1, ''@''(x, y) f2, ...]\n\ +@item @var{Boundary} is an Array which contains the label(s) of the \ +side(s) where the BC has to be applied.\n\ @end itemize\n\ The output @var{BC} is an object which contains the boundary conditions\n\ @seealso{Mesh, FunctionSpace}\n\
--- a/src/Expression.cc Fri Nov 08 00:05:33 2013 +0000 +++ b/src/Expression.cc Fri Nov 08 00:29:56 2013 +0000 @@ -20,14 +20,16 @@ DEFUN_DLD (Expression, args, , "-*- texinfo -*-\n\ @deftypefn {Function File} {[@var{f}]} = \ -Expression (@var{name}, @var{Functio handle}\n\ +Expression (@var{name}, @var{Function_handle})\n\ +Creates an object with the value specified as a function handle.\n\ The input parameters are\n\ @itemize @bullet \n\ -@item @var{name} is the name of the coefficient declared in the .ufl file\n\ -@item @var{Functio handle} is a function handle which contains the expression\ -that we want to apply for our coefficient\n\ +@item @var{name} is the name of the coefficient as it is declared in the ufl \ +file\n\ +@item @var{Function_handle} is a function handle which specify the expression \ +to apply for our coefficient\n\ @end itemize\n\ -The output @var{f} is an object which contains a representation \n\ +The output @var{f} is an object which contains a representation \ of the function\n\ @seealso{Constant, Function}\n\ @end deftypefn")
--- a/src/Function.cc Fri Nov 08 00:05:33 2013 +0000 +++ b/src/Function.cc Fri Nov 08 00:29:56 2013 +0000 @@ -21,17 +21,19 @@ DEFUN_DLD (Function, args, , "-*- texinfo -*-\n\ @deftypefn {Function File} {[@var{func}]} = \ -Function (@var{name}, @var{Functional Space} or @var{Function},\ -@var{Vector} or @var{index})\n\ -These function can be used in two ways\n\ +Function (@var{name}, @var{FunctionSpace} (or @var{Function}),\ +@var{Vector} (or @var{index}))\n\ +Initialize an object with the values specified in a vector or extracting \ +a component from a vectorial field.\n\ +This function can be used in two different ways\n\ @itemize @bullet \n\ @item To create a function from a vector. In this case, the arguments are:\n\ @itemize @bullet \n\ @item @var{name} is a string representing the name of the function\n\ -@item @var{Functional Space} is the fem-fenics functional space where\ +@item @var{FunctionSpace} is the fem-fenics function space where \ the vector is defined\n\ -@item @var{Vector} contains the value of the coefficients\ -for the basis functions of @var{Functional Space}\n\ +@item @var{Vector} specifies the values of the coefficients\ +for each basisc function of the @var{FunctioSpace}\n\ @end itemize\n\ @item To extract a scalar field from a vectorial one\n\ @itemize @bullet \n\ @@ -41,8 +43,9 @@ Index starts from 1. \n\ @end itemize\n\ @end itemize \n\ -The output @var{func} is an object which contain a representation of the\ -function @var{Vector} which can be plotted or saved.\n\ +The output @var{func} is an object which contains a representation of the \ +function @var{Vector} which can be plotted or saved or passed as argument \ +for a variational problem.\n\ @seealso{Constant, Expression, plot, save}\n\ @end deftypefn") {