Mercurial > fem-fenics-eugenio
diff src/MeshFunction.cc @ 270:f4d6ae912a08 default tip
Correct typos in the doc-strings
author | Eugenio Gianniti <eugenio.gianniti@mail.polimi.it> |
---|---|
date | Thu, 14 Aug 2014 17:55:32 +0200 |
parents | 61830a4f9ab9 |
children |
line wrap: on
line diff
--- a/src/MeshFunction.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/MeshFunction.cc Thu Aug 14 17:55:32 2014 +0200 @@ -27,16 +27,16 @@ MeshFunction (@var{type}, @var{Mesh}, @var{filename})\n\ @deftypefnx {Function File} {[@var{meshfunc}]} = \ MeshFunction (@var{type}, @var{Mesh}, @var{dim}, @var{value}) \n\ -Initialize a meshfunction with the values contained in a file.\n\ +Initialize a MeshFunction with the values contained in a file.\n\ The output @var{meshfunc} is an object which contains a representation of the \ -meshfunction in @var{filename} which can be used to mark subdomains or \ +mesh function in @var{filename} which can be used to mark subdomains or \ facets where Dirichlet boundary conditions are to be applied.\n\ Optionally, you can set a label identifying the @var{type} of markers, \ in order to use @var{meshfunc} to mark subdomains in BilinearForm or \ LinearForm. Three labels are recognized: ""dx"" for cell markers, \ ""ds"" for exterior facets and ""dS"" for interior facets.\n\ With the third invocation listed above it is possible to initialize \ -a meshfunction of topological dimension @var{dim} on @var{Mesh}, setting all \ +a mesh function of topological dimension @var{dim} on @var{Mesh}, setting all \ of its values to @var{value}, which is an integer.\n\ @seealso{DirichletBC, save, BilinearForm, LinearForm, mark}\n\ @end deftypefn")