← Back to branch summary

~njansson/dolfin/hpc

« back to all changes in this revision

Viewing changes to dolfin/swig/dolfin_docstrings.i

  • Committer: Anders Logg
  • Date: 2008-05-21 22:42:48 UTC
  • mfrom: (2668.6.1 trunk)
  • mto: (2668.8.3 trunk)
  • mto: This revision was merged to the branch mainline in revision 2670.
  • Revision ID: logg@simula.no-20080521224248-7baydkw3uy323fur
merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
dolfin/swig/dolfin_docstrings.i
491
491
where u is the solution to be computed, g is a function and G is a sub
492
492
domain of the mesh.
493
493
 
494
 
A DirichletBC is specified by a Function, a Mesh, a MeshFunction<uint>
495
 
over the facets of the mesh and an integer sub_domain specifying the
496
 
sub domain on which the boundary condition is to be applied.
 
494
A DirichletBC is specified by the Function g, the Mesh, and boundary
 
495
indicators on (a subset of) the mesh boundary.
 
496
 
 
497
The boundary indicators may be specified in a number of different
 
498
ways.
 
499
 
 
500
The simplest approach is to specify the boundary by a SubDomain
 
501
object, using the inside() function to specify on which facets the
 
502
boundary conditions should be applied.
 
503
 
 
504
Alternatively, the boundary may be specified by a MeshFunction
 
505
labeling all mesh facets together with a number that specifies which
 
506
facets should be included in the boundary.
 
507
 
 
508
The third option is to attach the boundary information to the mesh.
 
509
This is handled automatically when exporting a mesh from for example
 
510
VMTK.
497
511
 
498
512
For mixed systems (vector-valued and mixed elements), an optional set
499
513
of parameters may be used to specify for which sub system the boundary
511
525
 
512
526
%feature("docstring")  dolfin::DirichletBC::DirichletBC "
513
527
 
 
528
Create boundary condition for boundary data included in the mesh. ";
 
529
 
 
530
%feature("docstring")  dolfin::DirichletBC::DirichletBC "
 
531
 
514
532
Create sub system boundary condition for sub domain. ";
515
533
 
516
534
%feature("docstring")  dolfin::DirichletBC::DirichletBC "
520
538
 
521
539
%feature("docstring")  dolfin::DirichletBC::DirichletBC "
522
540
 
523
 
Simple creation of boundary condition with given value on the entire
524
 
boundary. ";
 
541
Create sub system boundary condition for boundary data included in the
 
542
mesh. ";
525
543
 
526
544
%feature("docstring")  dolfin::DirichletBC::~DirichletBC "
527
545
 
2131
2149
 
2132
2150
%feature("docstring")  dolfin::Mesh::topology "
2133
2151
 
2134
 
Return mesh topology. ";
 
2152
Return mesh topology (non-const version). ";
2135
2153
 
2136
2154
%feature("docstring")  dolfin::Mesh::topology "
2137
2155
 
2138
 
Return mesh topology. ";
2139
 
 
2140
 
%feature("docstring")  dolfin::Mesh::geometry "
2141
 
 
2142
 
Return mesh geometry. ";
2143
 
 
2144
 
%feature("docstring")  dolfin::Mesh::geometry "
2145
 
 
2146
 
Return mesh geometry. ";
 
2156
Return mesh topology (const version). ";
 
2157
 
 
2158
%feature("docstring")  dolfin::Mesh::geometry "
 
2159
 
 
2160
Return mesh geometry (non-const version). ";
 
2161
 
 
2162
%feature("docstring")  dolfin::Mesh::geometry "
 
2163
 
 
2164
Return mesh geometry (const version). ";
 
2165
 
 
2166
%feature("docstring")  dolfin::Mesh::data "
 
2167
 
 
2168
Return mesh data. ";
2147
2169
 
2148
2170
%feature("docstring")  dolfin::Mesh::type "
2149
2171
 
2166
2188
 
2167
2189
Compute all entities and connectivity. ";
2168
2190
 
 
2191
%feature("docstring")  dolfin::Mesh::clear "
 
2192
 
 
2193
Clear all mesh data. ";
 
2194
 
2169
2195
%feature("docstring")  dolfin::Mesh::order "
2170
2196
 
2171
2197
Order all mesh entities (not needed if \"mesh order entities\" is
2281
2307
Display data. ";
2282
2308
 
2283
2309
 
 
2310
// File: classdolfin_1_1MeshData.xml
 
2311
%feature("docstring") dolfin::MeshData "
 
2312
 
 
2313
The class MeshData is a container for auxiliary mesh data, represented
 
2314
either as MeshFunctions over topological mesh entities or Arrays. Each
 
2315
dataset is identified by a unique user-specified string.
 
2316
 
 
2317
Currently, only uint-valued data is supported.
 
2318
 
 
2319
C++ includes: MeshData.h ";
 
2320
 
 
2321
%feature("docstring")  dolfin::MeshData::MeshData "
 
2322
 
 
2323
Constructor. ";
 
2324
 
 
2325
%feature("docstring")  dolfin::MeshData::~MeshData "
 
2326
 
 
2327
Destructor. ";
 
2328
 
 
2329
%feature("docstring")  dolfin::MeshData::clear "
 
2330
 
 
2331
Clear all data. ";
 
2332
 
 
2333
%feature("docstring")  dolfin::MeshData::createMeshFunction "
 
2334
 
 
2335
Create MeshFunction with given name on entities of given dimension. ";
 
2336
 
 
2337
%feature("docstring")  dolfin::MeshData::createArray "
 
2338
 
 
2339
Create Array with given name and size. ";
 
2340
 
 
2341
%feature("docstring")  dolfin::MeshData::meshfunction "
 
2342
 
 
2343
Return MeshFunction with given name (returning zero if data is not
 
2344
available). ";
 
2345
 
 
2346
%feature("docstring")  dolfin::MeshData::array "
 
2347
 
 
2348
Return Array with given name (returning zero if data is not
 
2349
available). ";
 
2350
 
 
2351
%feature("docstring")  dolfin::MeshData::disp "
 
2352
 
 
2353
Display data. ";
 
2354
 
 
2355
 
2284
2356
// File: classdolfin_1_1MeshEditor.xml
2285
2357
%feature("docstring") dolfin::MeshEditor "
2286
2358
 
4778
4850
// File: MeshConnectivity_8h.xml
4779
4851
 
4780
4852
 
 
4853
// File: MeshData_8h.xml
 
4854
 
 
4855
 
4781
4856
// File: MeshEditor_8h.xml
4782
4857
 
4783
4858