dolfin_docstrings.i

利用C

Return number of vertices ";

%feature("docstring")  dolfin::Graph::numEdges "

Return number of edges. ";

%feature("docstring")  dolfin::Graph::numEdges "

Return number of edges incident to vertex u. ";

%feature("docstring")  dolfin::Graph::numArches "

Return number of arches (outgoing edges). ";

%feature("docstring")  dolfin::Graph::adjacent "

Check if vertex u is adjacent to vertex v. ";

%feature("docstring")  dolfin::Graph::edgeWeights "

Return edge weights. ";

%feature("docstring")  dolfin::Graph::vertexWeights "

Return vertex weights. ";

%feature("docstring")  dolfin::Graph::connectivity "

Return array of edges for all vertices. ";

%feature("docstring")  dolfin::Graph::offsets "

Return array of offsets for edges of all vertices. ";

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

Return graph type. ";

%feature("docstring")  dolfin::Graph::partition "

Partition a graph into num_part partitions. ";

%feature("docstring")  dolfin::Graph::typestr "

Return graph type as a string. ";

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

Display graph data. ";

%feature("docstring")  dolfin::Graph::clear "

Clear graph data. ";


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

A simple graph editor for creating graphs.

C++ includes: GraphEditor.h ";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::GraphEditor::open "

Open graph of given type. ";

%feature("docstring")  dolfin::GraphEditor::open "

Open graph of given type. ";

%feature("docstring")  dolfin::GraphEditor::initVertices "

Specify number of vertices. ";

%feature("docstring")  dolfin::GraphEditor::initEdges "

Specify number of edges. ";

%feature("docstring")  dolfin::GraphEditor::addVertex "

Add vertex v. ";

%feature("docstring")  dolfin::GraphEditor::addEdge "

Add edge from vertex u to vertex v. ";

%feature("docstring")  dolfin::GraphEditor::close "

Close graph, finish editing. ";


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

This class provides a set of functions to partition a Graph.

C++ includes: GraphPartition.h ";


// File: classdolfin_1_1Homotopy.xml
%feature("docstring") dolfin::Homotopy "";

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

Create homotopy for system of given size. ";

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

Destructor. ";

%feature("docstring")  dolfin::Homotopy::solve "

Solve homotopy. ";

%feature("docstring")  dolfin::Homotopy::solutions "

Return array of solutions found. ";

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

Return initial value (solution of G(z) = 0), optional. ";

%feature("docstring")  dolfin::Homotopy::F "

Compute y = F(z). ";

%feature("docstring")  dolfin::Homotopy::JF "

Compute y = F'(z) x. ";

%feature("docstring")  dolfin::Homotopy::G "

Compute y = G(z), optional. ";

%feature("docstring")  dolfin::Homotopy::JG "

Compute y = G'(z) x, optional. ";

%feature("docstring")  dolfin::Homotopy::modify "

Modify or substitute found solution (optional). ";

%feature("docstring")  dolfin::Homotopy::verify "

Check if found solution is correct (optional). ";

%feature("docstring")  dolfin::Homotopy::degree "

Return degree of polynomial F_i(z). ";


// File: classdolfin_1_1IntersectionDetector.xml
%feature("docstring") dolfin::IntersectionDetector "";

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

Constructor. ";

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

Destructor. ";

%feature("docstring")  dolfin::IntersectionDetector::overlap "

Compute overlap with mesh. ";

%feature("docstring")  dolfin::IntersectionDetector::overlap "

Compute overlap with point. ";

%feature("docstring")  dolfin::IntersectionDetector::overlap "

Compute overlap with bounding box. ";

%feature("docstring")  dolfin::IntersectionDetector::overlap "

Compute which cells are intersected by a polygon (defined by points).
";


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

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

C++ includes: SpecialFunctions.h ";

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

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

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


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

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

C++ includes: SpecialFunctions.h ";

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

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

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


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

This class defines an interface for a Krylov solver. The underlying
Krylov solver type is defined in default_type.h.

C++ includes: KrylovSolver.h ";

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

Create Krylov solver. ";

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

Destructor. ";

%feature("docstring")  dolfin::KrylovSolver::solve "

Solve linear system Ax = b. ";


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

Lagrange polynomial (basis) with given degree q determined by n = q +
1 nodal points.

Example: q = 1 (n = 2)

Lagrange p(1); p.set(0, 0.0); p.set(1, 1.0);

This creates a Lagrange polynomial (actually two Lagrange
polynomials):

p(0,x) = 1 - x (one at x = 0, zero at x = 1) p(1,x) = x (zero at x =
0, one at x = 1)

C++ includes: Lagrange.h ";

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

Constructor. ";

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

Copy constructor. ";

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

Destructor. ";

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

Specify point. ";

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

Return number of points. ";

%feature("docstring")  dolfin::Lagrange::degree "

Return degree. ";

%feature("docstring")  dolfin::Lagrange::point "

Return point. ";

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

Return value of polynomial i at given point x. ";

%feature("docstring")  dolfin::Lagrange::ddx "

Return derivate of polynomial i at given point x. ";

%feature("docstring")  dolfin::Lagrange::dqdx "

Return derivative q (a constant) of polynomial. ";

%feature("docstring")  dolfin::Lagrange::disp "";


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

Legendre polynomial of given degree n on the interval [-1,1].

P0(x) = 1 P1(x) = x P2(x) = (3x^2 - 1) / 2 ...

The function values and derivatives are computed using three-term
recurrence formulas.

C++ includes: Legendre.h ";

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

%feature("docstring")  dolfin::Legendre::ddx "

Evaluation of derivative at given point. ";

%feature("docstring")  dolfin::Legendre::d2dx "

Evaluation of second derivative at given point. ";


// File: classdolfin_1_1LinearAlgebraFactory.xml
%feature("docstring") dolfin::LinearAlgebraFactory "";

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

Constructor. ";

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

Destructor. ";

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

Create empty matrix. ";

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

Create empty vector. ";

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

Create empty sparsity pattern. ";


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

A LinearPDE represents a (system of) linear partial differential
equation(s) in variational form: Find u in V such that

a(v, u) = L(v) for all v in V',

where a is a bilinear form and L is a linear form.

C++ includes: LinearPDE.h ";

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

Define a linear PDE with natural boundary conditions. ";

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

Define a linear PDE with a single Dirichlet boundary condition. ";

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

Define a linear PDE with a set of Dirichlet boundary conditions. ";

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

Destructor. ";

%feature("docstring")  dolfin::LinearPDE::solve "

Solve PDE system. ";

%feature("docstring")  dolfin::LinearPDE::solve "

Solve PDE system and extract sub functions. ";

%feature("docstring")  dolfin::LinearPDE::solve "

Solve PDE system and extract sub functions. ";


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

This class provides a general solver for linear systems Ax = b.
Available methods are defined in SolverType.h and available
preconditioners are defined in PreconditionerType.h.

C++ includes: LinearSolver.h ";

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

Create linear solver. ";

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

Destructor. ";

%feature("docstring")  dolfin::LinearSolver::solve "

Solve linear system Ax = b. ";


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

List is a container that provides O(n) access time to elements and
O(n) memory overhead. However, a List can be grown/shrunk without
reallocation and spliced together with other lists, etc.

It is a wrapper for std::list (doubly-linked list), so see the STL
manual for further details:http://www.sgi.com/tech/stl/

C++ includes: List.h ";

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

Create empty list. ";

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

Copy constructor. ";


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

Lobatto (Gauss-Lobatto) quadrature on the interval [-1,1]. The n
quadrature points are given by the end-points -1 and 1, and the zeros
of P{n-1}'(x), where P{n-1}(x) is the (n-1):th Legendre polynomial.

The quadrature points are computed using Newton's method, and the
quadrature weights are computed by solving a linear system determined
by the condition that Lobatto quadrature with n points should be exact
for polynomials of degree 2n-3.

C++ includes: LobattoQuadrature.h ";

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

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

Display quadrature data. ";


// File: classdolfin_1_1LogStream.xml
%feature("docstring") dolfin::LogStream "";

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

%feature("docstring")  dolfin::LogStream::~LogStream "";

%feature("docstring")  dolfin::LogStream::disp "";


// File: classdolfin_1_1LUSolver.xml
%feature("docstring") dolfin::LUSolver "";

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

LU solver for the built-in LA backends. ";

%feature("docstring")  dolfin::LUSolver::~LUSolver "";

%feature("docstring")  dolfin::LUSolver::solve "";

%feature("docstring")  dolfin::LUSolver::factorize "";

%feature("docstring")  dolfin::LUSolver::factorized_solve "";


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

This class provides the default DOLFIN matrix class, based on the
default DOLFIN linear algebra backend.

C++ includes: Matrix.h ";

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

Create empty matrix. ";

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

Create M x N matrix. ";

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

Copy constructor. ";

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

Destructor. ";

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

Initialize zero tensor using sparsity pattern. ";

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

Return copy of tensor. ";

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

Return size of given dimension. ";

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

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

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

Finalize assembly of tensor. ";

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

Display tensor. ";

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

Initialize M x N matrix. ";

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

Get block of values. ";