dolfin_docstrings.i

利用C

%feature("docstring")  dolfin::dGqMethod::ueval "

Evaluate solution at given node (inline optimized). ";

%feature("docstring")  dolfin::dGqMethod::residual "

Compute residual at right end-point. ";

%feature("docstring")  dolfin::dGqMethod::residual "

Compute residual at right end-point. ";

%feature("docstring")  dolfin::dGqMethod::timestep "

Compute new time step based on the given residual. ";

%feature("docstring")  dolfin::dGqMethod::error "

Compute error estimate (modulo stability factor). ";

%feature("docstring")  dolfin::dGqMethod::disp "

Display method data. ";


// File: classdolfin_1_1DirectedClique.xml
%feature("docstring") dolfin::DirectedClique "

A directed graph where all vertices are adjacent to each other. The
number of vertices is given by num_vertices >= 1. The number of edges
is given by (num_vertices - 1) * num_vertices)

C++ includes: DirectedClique.h ";

%feature("docstring")  dolfin::DirectedClique::DirectedClique "";


// File: classdolfin_1_1DirichletBC.xml
%feature("docstring") dolfin::DirichletBC "

This class specifies the interface for setting (strong) Dirichlet
boundary conditions for partial differential equations,

u = g on G,

where u is the solution to be computed, g is a function and G is a sub
domain of the mesh.

A DirichletBC is specified by the Function g, the Mesh, and boundary
indicators on (a subset of) the mesh boundary.

The boundary indicators may be specified in a number of different
ways.

The simplest approach is to specify the boundary by a SubDomain
object, using the inside() function to specify on which facets the
boundary conditions should be applied.

Alternatively, the boundary may be specified by a MeshFunction
labeling all mesh facets together with a number that specifies which
facets should be included in the boundary.

The third option is to attach the boundary information to the mesh.
This is handled automatically when exporting a mesh from for example
VMTK.

For mixed systems (vector-valued and mixed elements), an optional set
of parameters may be used to specify for which sub system the boundary
condition should be specified.

C++ includes: DirichletBC.h ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create boundary condition for sub domain. ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create boundary condition for sub domain specified by index. ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create boundary condition for boundary data included in the mesh. ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create sub system boundary condition for sub domain. ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create sub system boundary condition for sub domain specified by
index. ";

%feature("docstring")  dolfin::DirichletBC::DirichletBC "

Create sub system boundary condition for boundary data included in the
mesh. ";

%feature("docstring")  dolfin::DirichletBC::~DirichletBC "

Destructor. ";

%feature("docstring")  dolfin::DirichletBC::apply "

Apply boundary condition to linear system. ";

%feature("docstring")  dolfin::DirichletBC::apply "

Apply boundary condition to linear system. ";

%feature("docstring")  dolfin::DirichletBC::apply "

Apply boundary condition to linear system for a nonlinear problem. ";

%feature("docstring")  dolfin::DirichletBC::apply "

Apply boundary condition to linear system for a nonlinear problem. ";

%feature("docstring")  dolfin::DirichletBC::zero "

Make row associated with boundary conditions zero, useful for non-
diagonal matrices in a block matrix. ";

%feature("docstring")  dolfin::DirichletBC::zero "

Make row associated with boundary conditions zero, useful for non-
diagonal matrices in a block matrix. ";

%feature("docstring")  dolfin::DirichletBC::setSubSystem "

Set (or update) value for sub system. ";

%feature("docstring")  dolfin::DirichletBC::mesh "

Return mesh. ";


// File: classdolfin_1_1DofMap.xml
%feature("docstring") dolfin::DofMap "

This class handles the mapping of degrees of freedom. It wraps a
ufc::dof_map on a specific mesh and provides optional precomputation
and reordering of dofs.

C++ includes: DofMap.h ";

%feature("docstring")  dolfin::DofMap::DofMap "

Create dof map on mesh. ";

%feature("docstring")  dolfin::DofMap::DofMap "

Create dof map on mesh (parallel). ";

%feature("docstring")  dolfin::DofMap::DofMap "

Create dof map on mesh. ";

%feature("docstring")  dolfin::DofMap::DofMap "

Create dof map on mesh (parallel). ";

%feature("docstring")  dolfin::DofMap::~DofMap "

Destructor. ";

%feature("docstring")  dolfin::DofMap::signature "

Return a string identifying the dof map. ";

%feature("docstring")  dolfin::DofMap::global_dimension "

Return the dimension of the global finite element function space. ";

%feature("docstring")  dolfin::DofMap::local_dimension "

Return the dimension of the local finite element function space. ";

%feature("docstring")  dolfin::DofMap::macro_local_dimension "

Return the dimension of the local finite element function space. ";

%feature("docstring")  dolfin::DofMap::num_facet_dofs "

Return number of facet dofs. ";

%feature("docstring")  dolfin::DofMap::tabulate_dofs "

Tabulate the local-to-global mapping of dofs on a cell. ";

%feature("docstring")  dolfin::DofMap::tabulate_facet_dofs "

Tabulate local-local facet dofs. ";

%feature("docstring")  dolfin::DofMap::tabulate_dofs "

Tabulate the local-to-global mapping of dofs on a ufc cell. ";

%feature("docstring")  dolfin::DofMap::tabulate_coordinates "";

%feature("docstring")  dolfin::DofMap::extractDofMap "

Extract sub dof map. ";

%feature("docstring")  dolfin::DofMap::mesh "

Return mesh associated with map. ";

%feature("docstring")  dolfin::DofMap::build "

Build parallel dof map. ";

%feature("docstring")  dolfin::DofMap::getMap "

Return renumbering (used for testing). ";

%feature("docstring")  dolfin::DofMap::disp "

Display mapping. ";


// File: classdolfin_1_1DofMapSet.xml
%feature("docstring") dolfin::DofMapSet "

This class provides storage and caching of (precomputed) dof maps and
enables reuse of already computed dof maps with equal signatures.

C++ includes: DofMapSet.h ";

%feature("docstring")  dolfin::DofMapSet::DofMapSet "

Create empty set of dof maps. ";

%feature("docstring")  dolfin::DofMapSet::DofMapSet "

Create set of dof maps. ";

%feature("docstring")  dolfin::DofMapSet::DofMapSet "

Create set of dof maps (parallel). ";

%feature("docstring")  dolfin::DofMapSet::DofMapSet "

Create set of dof maps. ";

%feature("docstring")  dolfin::DofMapSet::DofMapSet "

Create set of dof maps (parallel). ";

%feature("docstring")  dolfin::DofMapSet::~DofMapSet "

Destructor. ";

%feature("docstring")  dolfin::DofMapSet::update "

Update set of dof maps for given form. ";

%feature("docstring")  dolfin::DofMapSet::update "

Update set of dof maps for given form (parallel). ";

%feature("docstring")  dolfin::DofMapSet::update "

Update set of dof maps for given form. ";

%feature("docstring")  dolfin::DofMapSet::update "

Update set of dof maps for given form (parallel). ";

%feature("docstring")  dolfin::DofMapSet::size "

Return number of dof maps. ";

%feature("docstring")  dolfin::DofMapSet::build "

Build parallel dof maps. ";

%feature("docstring")  dolfin::DofMapSet::parallel "";


// File: classdolfin_1_1DomainBoundary.xml
%feature("docstring") dolfin::DomainBoundary "

This class provides a SubDomain which picks out the boundary of a
mesh, and provides a convenient way to specify boundary conditions on
the entire boundary of a mesh.

C++ includes: DomainBoundary.h ";

%feature("docstring")  dolfin::DomainBoundary::DomainBoundary "

Constructor. ";

%feature("docstring")  dolfin::DomainBoundary::~DomainBoundary "

Destructor. ";

%feature("docstring")  dolfin::DomainBoundary::inside "

Return true for points on the boundary. ";


// File: classdolfin_1_1Edge.xml
%feature("docstring") dolfin::Edge "

An Edge is a MeshEntity of topological dimension 1.

C++ includes: Edge.h ";

%feature("docstring")  dolfin::Edge::Edge "

Create edge on given mesh. ";

%feature("docstring")  dolfin::Edge::Edge "

Create edge from mesh entity. ";

%feature("docstring")  dolfin::Edge::~Edge "

Destructor. ";

%feature("docstring")  dolfin::Edge::length "

Compute Euclidian length of edge. ";

%feature("docstring")  dolfin::Edge::midpoint "

Compute coordinates of edge midpoint as a 3D point value. ";


// File: classdolfin_1_1EdgeIterator.xml
%feature("docstring") dolfin::EdgeIterator "

An EdgeIterator is a MeshEntityIterator of topological dimension 1.

C++ includes: Edge.h ";

%feature("docstring")  dolfin::EdgeIterator::EdgeIterator "";

%feature("docstring")  dolfin::EdgeIterator::EdgeIterator "";


// File: classdolfin_1_1ElementLibrary.xml
%feature("docstring") dolfin::ElementLibrary "

Library of pregenerated finite elements and dof maps.

C++ includes: ElementLibrary.h ";


// File: classdolfin_1_1Event.xml
%feature("docstring") dolfin::Event "

A event is a string message which is displayed only a limited number
of times.

Example of usage:

Event event(\"System is stiff, damping is needed.\"); while () { ...
if ( ... ) { event(); ... } }

C++ includes: Event.h ";

%feature("docstring")  dolfin::Event::Event "

Constructor. ";

%feature("docstring")  dolfin::Event::~Event "

Destructor. ";

%feature("docstring")  dolfin::Event::count "

Display count. ";

%feature("docstring")  dolfin::Event::maxcount "

Maximum display count. ";


// File: classdolfin_1_1Face.xml
%feature("docstring") dolfin::Face "

A Face is a MeshEntity of topological dimension 2.

C++ includes: Face.h ";

%feature("docstring")  dolfin::Face::Face "

Constructor. ";

%feature("docstring")  dolfin::Face::~Face "

Destructor. ";


// File: classdolfin_1_1FaceIterator.xml
%feature("docstring") dolfin::FaceIterator "

A FaceIterator is a MeshEntityIterator of topological dimension 2.

C++ includes: Face.h ";

%feature("docstring")  dolfin::FaceIterator::FaceIterator "";

%feature("docstring")  dolfin::FaceIterator::FaceIterator "";


// File: classdolfin_1_1Facet.xml
%feature("docstring") dolfin::Facet "

A Facet is a MeshEntity of topological codimension 1.

C++ includes: Facet.h ";

%feature("docstring")  dolfin::Facet::Facet "

Constructor. ";

%feature("docstring")  dolfin::Facet::~Facet "

Destructor. ";


// File: classdolfin_1_1FacetArea.xml
%feature("docstring") dolfin::FacetArea "

This function represents the area/length of a mesh facet.

C++ includes: SpecialFunctions.h ";

%feature("docstring")  dolfin::FacetArea::FacetArea "";

%feature("docstring")  dolfin::FacetArea::eval "

Evaluate function at given point (overload for scalar user-defined
function). ";


// File: classdolfin_1_1FacetIterator.xml
%feature("docstring") dolfin::FacetIterator "

A FacetIterator is a MeshEntityIterator of topological codimension 1.

C++ includes: Facet.h ";

%feature("docstring")  dolfin::FacetIterator::FacetIterator "";

%feature("docstring")  dolfin::FacetIterator::FacetIterator "";


// File: classdolfin_1_1FacetNormal.xml
%feature("docstring") dolfin::FacetNormal "

This function represents the outward unit normal on mesh facets. Note
that it is only nonzero on cell facets (not on cells).

C++ includes: SpecialFunctions.h ";

%feature("docstring")  dolfin::FacetNormal::FacetNormal "";

%feature("docstring")  dolfin::FacetNormal::eval "

Evaluate function at given point (overload for scalar user-defined
function). ";


// File: classdolfin_1_1File.xml
%feature("docstring") dolfin::File "

A File represents a data file for reading and writing objects. Unless
specified explicitly, the format is determined by the file name
suffix.

C++ includes: File.h ";

%feature("docstring")  dolfin::File::File "

Create a file with given name. ";

%feature("docstring")  dolfin::File::File "

Create a file with given name and type (format). ";

%feature("docstring")  dolfin::File::~File "

Destructor. ";


// File: classdolfin_1_1Form.xml
%feature("docstring") dolfin::Form "

Base class for UFC code generated by FFC for DOLFIN with option -l.

C++ includes: Form.h ";

%feature("docstring")  dolfin::Form::Form "

Constructor. ";

%feature("docstring")  dolfin::Form::~Form "

Destructor. ";

%feature("docstring")  dolfin::Form::form "

Return UFC form. ";

%feature("docstring")  dolfin::Form::coefficients "

Return array of coefficients. ";

%feature("docstring")  dolfin::Form::updateDofMaps "

Create degree of freedom maps. ";

%feature("docstring")  dolfin::Form::updateDofMaps "

Create degree of freedom maps. ";

%feature("docstring")  dolfin::Form::setDofMaps "

Set degree of freedom maps. ";

%feature("docstring")  dolfin::Form::dofMaps "

Return DofMapSet. ";


// File: classdolfin_1_1Function.xml
%feature("docstring") dolfin::Function "

This class represents a function that can be evaluated on a mesh. The
actual representation of the function can vary, but the typical
representation is in terms of a mesh, a vector of degrees of freedom,
a finite element and a dof map that determines the distribution of
degrees of freedom on the mesh.

It is also possible to have user-defined functions, either by