dolfin_docstrings.i

利用C

// An autogenerated docstringfile


// File: index.xml

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

This class provides functionality useful for implementation of ALE
(Arbitrary Lagrangian-Eulerian) methods, in particular moving the
boundary vertices of a mesh and then interpolating the new coordinates
for the interior vertices accordingly.

C++ includes: ALE.h ";


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

Array is a container that provides O(1) access time to elements and
O(1) memory overhead.

It is a wrapper for std::vector, so see the STL manual for further
details:http://www.sgi.com/tech/stl/

C++ includes: Array.h ";

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

Create empty array. ";

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

Create array of given size. ";

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

Create array containing two elements. ";

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

Create array containing three elements. ";

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

Create array containing four elements. ";

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

Create array containing five elements. ";

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

Copy constructor. ";

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

Destructor. ";


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

This class provides automated assembly of linear systems, or more
generally, assembly of a sparse tensor from a given variational form.

C++ includes: Assembler.h ";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble tensor from given variational form. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble tensor from given variational form over a sub domain. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble tensor from given variational form over a sub domain.

Assemble tensor from given variational form over sub domains ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble scalar from given variational form. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble scalar from given variational form over a sub domain. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble scalar from given variational form over sub domains. ";

%feature("docstring")  dolfin::Assembler::assemble "

Assemble tensor from given (UFC) form, coefficients and sub domains.
This is the main assembly function in DOLFIN. All other assembly
functions end up calling this function.

The MeshFunction arguments can be used to specify assembly over
subdomains of the mesh cells, exterior facets and interior facets.
Either a null pointer or an empty MeshFunction may be used to specify
that the tensor should be assembled over the entire set of cells or
facets. ";


// File: classdolfin_1_1AssemblyFactory.xml
%feature("docstring") dolfin::AssemblyFactory "";

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

Destructor. ";

%feature("docstring")  dolfin::AssemblyFactory::createMatrix "

Create empty matrix. ";

%feature("docstring")  dolfin::AssemblyFactory::createVector "

Create empty vector. ";

%feature("docstring")  dolfin::AssemblyFactory::createPattern "

Create empty sparsity pattern. ";


// File: classdolfin_1_1AssemblyMatrix.xml
%feature("docstring") dolfin::AssemblyMatrix "";

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

Create empty matrix. ";

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

Create M x N matrix. ";

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

Copy constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::AssemblyMatrix::init "

--- Implementation of the GenericTensor interface ---

Initialize zero tensor using sparsity pattern ";

%feature("docstring")  dolfin::AssemblyMatrix::copy "

Return copy of tensor. ";

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

Return size of given dimension. ";

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

Set all entries to zero and keep any sparse structure. ";

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

Finalize assembly of tensor. ";

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

Display tensor. ";

%feature("docstring")  dolfin::AssemblyMatrix::init "

Initialize M x N matrix. ";

%feature("docstring")  dolfin::AssemblyMatrix::get "

Get block of values. ";

%feature("docstring")  dolfin::AssemblyMatrix::set "

Set block of values. ";

%feature("docstring")  dolfin::AssemblyMatrix::add "

Add block of values. ";

%feature("docstring")  dolfin::AssemblyMatrix::getrow "

Get non-zero values of given row. ";

%feature("docstring")  dolfin::AssemblyMatrix::setrow "

Set values for given row. ";

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

Set given rows to zero. ";

%feature("docstring")  dolfin::AssemblyMatrix::ident "

Set given rows to identity matrix. ";

%feature("docstring")  dolfin::AssemblyMatrix::mult "";

%feature("docstring")  dolfin::AssemblyMatrix::factory "

--- Specialized matrix functions ---

Return linear algebra backend factory ";

%feature("docstring")  dolfin::AssemblyMatrix::init "

Initialize zero tensor of given rank and dimensions. ";


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

This function represents the average of the local mesh size on a given
mesh.

C++ includes: SpecialFunctions.h ";

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

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

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


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

Common base class for boundary conditions.

C++ includes: BoundaryCondition.h ";

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

Constructor. ";

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

Destructor. ";

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

Apply boundary condition to linear system. ";

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

Apply boundary condition to linear system. ";

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

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

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

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


// File: classdolfin_1_1BoundaryCondition_1_1LocalData.xml


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

A BoundaryMesh is a mesh over the boundary of some given mesh.

C++ includes: BoundaryMesh.h ";

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

Create an empty boundary mesh. ";

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

Create boundary mesh from given mesh. ";

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

Destructor. ";

%feature("docstring")  dolfin::BoundaryMesh::init "

Initialize boundary mesh. ";


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

A Cell is a MeshEntity of topological codimension 0.

C++ includes: Cell.h ";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::Cell::type "

Return type of cell. ";

%feature("docstring")  dolfin::Cell::orientation "

Compute orientation of cell (0 is right, 1 is left). ";

%feature("docstring")  dolfin::Cell::volume "

Compute (generalized) volume of cell. ";

%feature("docstring")  dolfin::Cell::diameter "

Compute diameter of cell. ";

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

Compute midpoint of cell. ";

%feature("docstring")  dolfin::Cell::normal "

Compute component i of normal of given facet with respect to the cell.
";

%feature("docstring")  dolfin::Cell::normal "

Compute normal of given facet with respect to the cell. ";

%feature("docstring")  dolfin::Cell::facetArea "

Compute the area/length of given facet with respect to the cell. ";


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

A CellIterator is a MeshEntityIterator of topological codimension 0.

C++ includes: Cell.h ";

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

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


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

Contains all numeric constants, such as nodal points and nodal
weights, needed for the cG(q) method. The order q must be at least 1.
Note that q refers to the polynomial order and not the order of
convergence for the method, which is 2q.

C++ includes: cGqMethod.h ";

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

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

Evaluate solution at given point. ";

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

Evaluate solution at given point. ";

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

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

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

Compute residual at right end-point. ";

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

Compute residual at right end-point. ";

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

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

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

Compute error estimate (modulo stability factor). ";

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

Display method data. ";


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

A ComplexODE represents an initial value problem for a system of
complex-valued ordinary differential equations:

M(z, t) z'(t) = f(z(t), t) on (0,T]

z(0) = z0,

where z(t) is a complex-valued vector of length n. The imaginary unit
is provided by the member variable j satisfying j^2 = -1.

This class is a wrapper for a standard real-valued ODE, and provides
an interface that automatically translates the given complex-valued
ODE of size n to a standard real-valued ODE of size N = 2n.

The real and imaginary parts of the solution are stored in the
following order in the solution vector u(t):

u = (Re z0, Im z0, Re z1, Im z1, ..., Re z_n-1, Im z_n-1).

C++ includes: ComplexODE.h ";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::ComplexODE::z0 "

Set initial values. ";

%feature("docstring")  dolfin::ComplexODE::f "

Evaluate right-hand side (multi-adaptive version). ";

%feature("docstring")  dolfin::ComplexODE::f "

Evaluate right-hand side (mono-adaptive version). ";

%feature("docstring")  dolfin::ComplexODE::M "

Compute product y = Mx for implicit system. ";

%feature("docstring")  dolfin::ComplexODE::J "

Compute product y = Jx for Jacobian J. ";

%feature("docstring")  dolfin::ComplexODE::k "

Return time step for component i (optional). ";

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

Update ODE, return false to stop (optional). ";

%feature("docstring")  dolfin::ComplexODE::u0 "

Return initial value for real-valued ODE. ";

%feature("docstring")  dolfin::ComplexODE::f "

Return right-hand side for real-valued ODE. ";

%feature("docstring")  dolfin::ComplexODE::f "

Evaluate right-hand side for real-valued ODE. ";

%feature("docstring")  dolfin::ComplexODE::M "

Compute product y = Mx for real-valued ODE. ";

%feature("docstring")  dolfin::ComplexODE::J "

Compute product y = Jx for real-valued ODE. ";

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

Return time step for real-valued ODE. ";

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

Update for real-valued ODE. ";


// File: classdolfin_1_1DefaultFactory.xml
%feature("docstring") dolfin::DefaultFactory "";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::DefaultFactory::createMatrix "

Create empty matrix. ";

%feature("docstring")  dolfin::DefaultFactory::createVector "

Create empty vector. ";

%feature("docstring")  dolfin::DefaultFactory::createPattern "

Create empty sparsity pattern. ";


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

Contains all numeric constants, such as nodal points and nodal
weights, needed for the dG(q) method. The order q must be at least 0.
Note that q refers to the polynomial order and not the order of
convergence for the method, which is 2q + 1.

C++ includes: dGqMethod.h ";

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

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

Evaluate solution at given point. ";

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

Evaluate solution at given point. ";