~njansson/dolfin/hpc

« back to all changes in this revision

Viewing changes to dolfin/swig/dolfin_docstrings.i

  • Committer: Anders Logg
  • Date: 2008-05-15 16:02:44 UTC
  • Revision ID: logg@simula.no-20080515160244-e2a4wkfxfzmts16s
Add new class SingularSolver:

This class provides a linear solver for singular linear systems
Ax = b where A has a one-dimensional null-space (kernel). This
may happen for example when solving Poisson's equation with
pure Neumann boundary conditions.

The solver attempts to create an extended non-singular system
by adding the constraint [1, 1, 1, ...]^T x = 0.

If an optional mass matrix M is supplied, the solver attempts
to create an extended non-singular system by adding the
constraint m^T x = 0 where m is the lumped mass matrix. This
corresponds to setting the average (integral) of the finite
element function with coefficients x to zero.

The solver makes not attempt to check that the null-space is
indeed one-dimensional. It is also assumed that the system
Ax = b retains its sparsity pattern between calls to solve().

Show diffs side-by-side

added added

removed removed

Lines of Context:
2598
2598
Evaluate scalar function at given point (overload for scalar user-
2599
2599
defined function). ";
2600
2600
 
 
2601
%feature("docstring")  dolfin::MeshSize::min "
 
2602
 
 
2603
Compute minimal cell diameter. ";
 
2604
 
2601
2605
 
2602
2606
// File: classdolfin_1_1MeshTopology.xml
2603
2607
%feature("docstring") dolfin::MeshTopology "
3445
3449
Destructor. ";
3446
3450
 
3447
3451
 
 
3452
// File: classdolfin_1_1SingularSolver.xml
 
3453
%feature("docstring") dolfin::SingularSolver "
 
3454
 
 
3455
This class provides a linear solver for singular linear systems Ax = b
 
3456
where A has a one-dimensional null-space (kernel). This may happen for
 
3457
example when solving Poisson's equation with pure Neumann boundary
 
3458
conditions.
 
3459
 
 
3460
The solver attempts to create an extended non-singular system by
 
3461
adding the constraint [1, 1, 1, ...]^T x = 0.
 
3462
 
 
3463
If an optional mass matrix M is supplied, the solver attempts to
 
3464
create an extended non-singular system by adding the constraint m^T x
 
3465
= 0 where m is the lumped mass matrix. This corresponds to setting the
 
3466
average (integral) of the finite element function with coefficients x
 
3467
to zero.
 
3468
 
 
3469
The solver makes not attempt to check that the null-space is indeed
 
3470
one-dimensional. It is also assumed that the system Ax = b retains its
 
3471
sparsity pattern between calls to solve().
 
3472
 
 
3473
C++ includes: SingularSolver.h ";
 
3474
 
 
3475
%feature("docstring")  dolfin::SingularSolver::SingularSolver "
 
3476
 
 
3477
Create linear solver. ";
 
3478
 
 
3479
%feature("docstring")  dolfin::SingularSolver::~SingularSolver "
 
3480
 
 
3481
Destructor. ";
 
3482
 
 
3483
%feature("docstring")  dolfin::SingularSolver::solve "
 
3484
 
 
3485
Solve linear system Ax = b. ";
 
3486
 
 
3487
%feature("docstring")  dolfin::SingularSolver::solve "
 
3488
 
 
3489
Solve linear system Ax = b using mass matrix M for setting constraint.
 
3490
";
 
3491
 
 
3492
 
3448
3493
// File: classdolfin_1_1SparsityPattern.xml
3449
3494
%feature("docstring") dolfin::SparsityPattern "
3450
3495
 
4585
4630
// File: Scalar_8h.xml
4586
4631
 
4587
4632
 
 
4633
// File: SingularSolver_8h.xml
 
4634
 
 
4635
 
4588
4636
// File: SLEPcEigenvalueSolver_8h.xml
4589
4637
 
4590
4638