Mercurial > fem-fenics-eugenio
changeset 179:8190736845fe
Update the Function description for the code release.
author | gedeone-octave <marcovass89@hotmail.it> |
---|---|
date | Thu, 07 Nov 2013 23:31:05 +0000 |
parents | 097026c0acb5 |
children | 2676200ae226 |
files | inst/import_ufl_BilinearForm.m inst/import_ufl_FunctionSpace.m inst/import_ufl_Functional.m inst/import_ufl_LinearForm.m inst/import_ufl_Problem.m |
diffstat | 5 files changed, 34 insertions(+), 22 deletions(-) [+] |
line wrap: on
line diff
--- a/inst/import_ufl_BilinearForm.m Thu Nov 07 00:03:08 2013 +0000 +++ b/inst/import_ufl_BilinearForm.m Thu Nov 07 23:31:05 2013 +0000 @@ -14,10 +14,13 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} = import_ufl_BilinearForm (myproblem) -## This function takes as input the name of the .ufl file where -## the BilinearForm is defined and import it inside Octave. -## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm} +## @deftypefn {Function File} {[]} = import_ufl_BilinearForm (@var{myproblem}) +## Import a BilinearForm from a ufl file. +## @var{myproblem} is the name of the ufl file where +## the BilinearForm is defined. This function creates in the pwd a file +## called @var{myproblem_BilinearForm.oct}. +## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, +## Functional} ## @end deftypefn function import_ufl_BilinearForm (var_prob)
--- a/inst/import_ufl_FunctionSpace.m Thu Nov 07 00:03:08 2013 +0000 +++ b/inst/import_ufl_FunctionSpace.m Thu Nov 07 23:31:05 2013 +0000 @@ -14,10 +14,13 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} = import_ufl_FunctionSpace (myproblem) -## This function takes as input the name of the .ufl file where -## the FunctionSpace is defined and import it inside Octave -## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm} +## @deftypefn {Function File} {[]} = import_ufl_FunctionSpace (@var{myproblem}) +## Import a FunctionSpace from a ufl file. +## @var{myproblem} is the name of the ufl file where +## the FunctionSpace is defined. This function creates in the pwd a file +## called @var{myproblem_FunctionSpace.oct}. +## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, +## Functional} ## @end deftypefn function import_ufl_FunctionSpace (var_prob)
--- a/inst/import_ufl_Functional.m Thu Nov 07 00:03:08 2013 +0000 +++ b/inst/import_ufl_Functional.m Thu Nov 07 23:31:05 2013 +0000 @@ -14,12 +14,14 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} = import_ufl_Functional (myproblem) -## This function takes as input the name of the .ufl file where -## the Functional is defined and import it inside Octavet. -## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm} +## @deftypefn {Function File} {[]} = import_ufl_Functional (@var{myproblem}) +## Import a Functional from a ufl file. +## @var{myproblem} is the name of the ufl file where +## the Functional is defined. This function creates in the pwd a file +## called @var{myproblem_Functional.oct}. +## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, +## Functional} ## @end deftypefn - function import_ufl_Functional (var_prob) if nargin != 1
--- a/inst/import_ufl_LinearForm.m Thu Nov 07 00:03:08 2013 +0000 +++ b/inst/import_ufl_LinearForm.m Thu Nov 07 23:31:05 2013 +0000 @@ -14,10 +14,13 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} = import_ufl_LinearForm (myproblem) -## This function takes as input the name of the .ufl file where -## the LinearForm is defined and import it inside Octave -## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm} +## @deftypefn {Function File} {[]} = import_ufl_LinearForm (@var{myproblem}) +## Import a LinearForm from a ufl file. +## @var{myproblem} is the name of the ufl file where +## the LinearForm is defined. This function creates in the pwd a file +## called @var{myproblem_LinearForm.oct}. +## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, +## Functional} ## @end deftypefn function import_ufl_LinearForm (var_prob)
--- a/inst/import_ufl_Problem.m Thu Nov 07 00:03:08 2013 +0000 +++ b/inst/import_ufl_Problem.m Thu Nov 07 23:31:05 2013 +0000 @@ -14,11 +14,12 @@ ## this program; if not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} = import_ufl_Problem (myproblem) -## This function take as input the name of the .ufl file where -## the Variational Problem is defined and import it inside Octave. -## It expect that a ilinearForm and a LinearForm are defined inside the .ufl file. -## @seealso{FunctionSpace, BilinearForm, LinearForm} +## @deftypefn {Function File} {[]} = import_ufl_Problem (@var{myproblem}) +## Import a Variational Problem from a ufl file. +## @var{myproblem} is the name of the ufl file where +## the BilinearForm, the LinearForm and the FunctionSpace are defined. +## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, +## Functional} ## @end deftypefn function import_ufl_Problem (var_prob)