← Back to branch summary

~corrado-maurini/dolfin/tao

« back to all changes in this revision

Viewing changes to dolfin/swig/la/docstrings.i

  • Committer: corrado maurini
  • Date: 2012-12-18 12:16:08 UTC
  • mfrom: (6685.78.207 trunk)
  • Revision ID: corrado.maurini@upmc.fr-20121218121608-nk82ly9jgsld9u84
updating with trunk, fix uint in TAO solver and hacking the check for tao FindTAO.cmake

Show diffs side-by-side

added added

removed removed

Lines of Context:
dolfin/swig/la/docstrings.i
273
273
important.
274
274
 
275
275
*Arguments*
276
 
    dim (int)
 
276
    dim (std::size_t)
277
277
        The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
278
278
";
279
279
 
715
715
Set operator (matrix) and preconditioner matrix
716
716
";
717
717
 
 
718
%feature("docstring")  dolfin::GenericLinearSolver::set_nullspace "
 
719
Set null space of the operator (matrix). This is used to solve
 
720
singular systems
 
721
";
 
722
 
718
723
%feature("docstring")  dolfin::GenericLinearSolver::solve "
719
724
**Overloaded versions**
720
725
 
748
753
  Solve linear system Ax = b
749
754
";
750
755
 
 
756
// Documentation extracted from: (module=la, header=GenericPreconditioner.h)
 
757
%feature("docstring")  dolfin::GenericPreconditioner "
 
758
This class provides a common base preconditioners.
 
759
";
 
760
 
 
761
%feature("docstring")  dolfin::GenericPreconditioner::set_nullspace "
 
762
Set the (approximate) null space of the preconditioner operator
 
763
(matrix). This is required for certain preconditioner types,
 
764
e.g. smoothed aggregation multigrid
 
765
";
 
766
 
751
767
// Documentation extracted from: (module=la, header=PETScObject.h)
752
768
%feature("docstring")  dolfin::PETScObject "
753
769
This class calls SubSystemsManager to initialise PETSc.
787
803
important.
788
804
 
789
805
*Arguments*
790
 
    dim (int)
 
806
    dim (std::size_t)
791
807
        The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
792
808
";
793
809
 
929
945
  important.
930
946
  
931
947
  *Arguments*
932
 
      dim (int)
 
948
      dim (std::size_t)
933
949
          The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
934
950
";
935
951
 
1137
1153
important.
1138
1154
 
1139
1155
*Arguments*
1140
 
    dim (int)
 
1156
    dim (std::size_t)
1141
1157
        The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
1142
1158
";
1143
1159
 
1193
1209
Return linear algebra backend factory
1194
1210
";
1195
1211
 
1196
 
%feature("docstring")  dolfin::PETScMatrix::set_near_nullspace "
1197
 
Set (approximate) null space of the matrix. This is used by
1198
 
some preconditioners.
1199
 
";
1200
 
 
1201
1212
%feature("docstring")  dolfin::PETScMatrix::norm "
1202
1213
Return norm of matrix
1203
1214
";
1250
1261
Set the precondtioner type and parameters
1251
1262
";
1252
1263
 
 
1264
%feature("docstring")  dolfin::PETScPreconditioner::set_nullspace "
 
1265
Set the (approximate) null space of the preconditioner operator
 
1266
(matrix). This is required for certain preconditioner types,
 
1267
e.g. smoothed aggregation multigrid
 
1268
";
 
1269
 
 
1270
%feature("docstring")  dolfin::PETScPreconditioner::nullspace "
 
1271
Return the PETSc null space
 
1272
";
 
1273
 
1253
1274
%feature("docstring")  dolfin::PETScPreconditioner::str "
1254
1275
Return informal string representation (pretty-print)
1255
1276
";
1256
1277
 
 
1278
%feature("docstring")  dolfin::PETScPreconditioner::preconditioners "
 
1279
Rerturn a list of available preconditioners
 
1280
";
 
1281
 
1257
1282
%feature("docstring")  dolfin::PETScPreconditioner::default_parameters "
1258
1283
Default parameter values
1259
1284
";
1469
1494
important.
1470
1495
 
1471
1496
*Arguments*
1472
 
    dim (int)
 
1497
    dim (std::size_t)
1473
1498
        The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
1474
1499
";
1475
1500
 
1821
1846
  Set operator (matrix) and preconditioner matrix
1822
1847
";
1823
1848
 
 
1849
%feature("docstring")  dolfin::PETScKrylovSolver::set_nullspace "
 
1850
Set null space of the operator (matrix). This is used to solve
 
1851
singular systems
 
1852
";
 
1853
 
1824
1854
%feature("docstring")  dolfin::PETScKrylovSolver::get_operator "
1825
1855
Get operator (matrix)
1826
1856
";
1865
1895
Default parameter values
1866
1896
";
1867
1897
 
1868
 
%feature("docstring")  dolfin::PETScKrylovSolver::init "
1869
 
Initialize KSP solver
1870
 
";
1871
 
 
1872
 
%feature("docstring")  dolfin::PETScKrylovSolver::write_report "
1873
 
Report the number of iterations
1874
 
";
1875
 
 
1876
1898
// Documentation extracted from: (module=la, header=PETScLUSolver.h)
1877
1899
%feature("docstring")  dolfin::PETScLUSolver "
1878
1900
This class implements the direct solution (LU factorization) for
2174
2196
important.
2175
2197
 
2176
2198
*Arguments*
2177
 
    dim (int)
 
2199
    dim (std::size_t)
2178
2200
        The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
2179
2201
";
2180
2202
 
3400
3422
  Set the Trilonos preconditioner parameters list (for use from Python)
3401
3423
";
3402
3424
 
3403
 
%feature("docstring")  dolfin::TrilinosPreconditioner::set_null_space "
 
3425
%feature("docstring")  dolfin::TrilinosPreconditioner::set_nullspace "
3404
3426
Set basis for the null space of the operator. Setting this
3405
3427
is critical to the performance of some preconditioners, e.g. ML.
3406
3428
The vectors spanning the null space are copied.
4070
4092
Set operator (matrix) and preconditioner matrix
4071
4093
";
4072
4094
 
 
4095
%feature("docstring")  dolfin::KrylovSolver::set_nullspace "
 
4096
Set null space of the operator (matrix). This is used to solve
 
4097
singular systems
 
4098
";
 
4099
 
4073
4100
%feature("docstring")  dolfin::KrylovSolver::solve "
4074
4101
**Overloaded versions**
4075
4102
 
4123
4150
Default parameter values
4124
4151
";
4125
4152
 
4126
 
// Documentation extracted from: (module=la, header=SingularSolver.h)
4127
 
%feature("docstring")  dolfin::SingularSolver "
4128
 
This class provides a linear solver for singular linear systems
4129
 
Ax = b where A has a one-dimensional null-space (kernel). This
4130
 
may happen for example when solving Poisson's equation with
4131
 
pure Neumann boundary conditions.
4132
 
 
4133
 
The solver attempts to create an extended non-singular system
4134
 
by adding the constraint [1, 1, 1, ...]^T x = 0.
4135
 
 
4136
 
If an optional mass matrix M is supplied, the solver attempts
4137
 
to create an extended non-singular system by adding the
4138
 
constraint m^T x = 0 where m is the lumped mass matrix. This
4139
 
corresponds to setting the average (integral) of the finite
4140
 
element function with coefficients x to zero.
4141
 
 
4142
 
The solver makes not attempt to check that the null-space is
4143
 
indeed one-dimensional. It is also assumed that the system
4144
 
Ax = b retains its sparsity pattern between calls to solve().
4145
 
";
4146
 
 
4147
 
%feature("docstring")  dolfin::SingularSolver::SingularSolver "
4148
 
Create linear solver
4149
 
";
4150
 
 
4151
 
%feature("docstring")  dolfin::SingularSolver::solve "
4152
 
**Overloaded versions**
4153
 
 
4154
 
* solve\ (A, x, b)
4155
 
 
4156
 
  Solve linear system Ax = b
4157
 
 
4158
 
* solve\ (A, x, b, M)
4159
 
 
4160
 
  Solve linear system Ax = b using mass matrix M for setting constraint
4161
 
";
4162
 
 
4163
 
%feature("docstring")  dolfin::SingularSolver::default_parameters "
4164
 
Default parameter values
4165
 
";
4166
 
 
4167
4153
// Documentation extracted from: (module=la, header=solve.h)
4168
4154
%feature("docstring")  dolfin::solve "
4169
4155
Solve linear system Ax = b
4256
4242
 
4257
4243
  Get sub-vector (const)
4258
4244
 
4259
 
* get_block\ (uint)
 
4245
* get_block\ ()
4260
4246
 
4261
4247
  Get sub-vector (non-const)
4262
4248
";