petsc4py.PETSc.DS¶
- class petsc4py.PETSc.DS¶
Bases:
ObjectDiscrete System object.
Enumerations
Methods Summary
create([comm])Create an empty DS.
destroy()Destroy the discrete system.
Return the number of components for each field on an evaluation point.
Return the coordinate dimension of the DS.
Return the size of the space for each field on an evaluation point.
getFieldIndex(disc)Return the index of the given field.
Return the number of fields in the DS.
Return the spatial dimension of the DS.
Return the total number of components in this system.
Return the total size of the approximation space for this system.
getType()Return the type of the discrete system.
setDiscretisation(f, disc)Set the discretization object for the given field.
Set parameters in a
DSfrom the options database.setType(ds_type)Build a particular type of a discrete system.
setUp()Construct data structures for the discrete system.
view([viewer])View a discrete system.
Methods Documentation
- create(comm=None)¶
Create an empty DS.
Collective.
The type can then be set with
setType.- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm.- Return type:
- destroy()¶
Destroy the discrete system.
Collective.
See also
create,petsc.PetscDSDestroySource code at petsc4py/PETSc/DS.pyx:38
- Return type:
- getComponents()¶
Return the number of components for each field on an evaluation point.
Not collective.
See also
petsc.PetscDSGetComponentsSource code at petsc4py/PETSc/DS.pyx:244
- Return type:
- getCoordinateDimension()¶
Return the coordinate dimension of the DS.
Not collective.
The coordinate dimension of the
DSis the dimension of the space into which the discretiaztions are embedded.See also
petsc.PetscDSGetCoordinateDimensionSource code at petsc4py/PETSc/DS.pyx:151
- Return type:
- getDimensions()¶
Return the size of the space for each field on an evaluation point.
Not collective.
See also
petsc.PetscDSGetDimensionsSource code at petsc4py/PETSc/DS.pyx:229
- Return type:
- getFieldIndex(disc)¶
Return the index of the given field.
Not collective.
See also
petsc.PetscDSGetFieldIndex
- getNumFields()¶
Return the number of fields in the DS.
Not collective.
See also
petsc.PetscDSGetNumFieldsSource code at petsc4py/PETSc/DS.pyx:168
- Return type:
- getSpatialDimension()¶
Return the spatial dimension of the DS.
Not collective.
The spatial dimension of the
DSis the topological dimension of the discretizations.See also
petsc.PetscDSGetSpatialDimensionSource code at petsc4py/PETSc/DS.pyx:134
- Return type:
- getTotalComponents()¶
Return the total number of components in this system.
Not collective.
See also
petsc.PetscDSGetTotalComponentsSource code at petsc4py/PETSc/DS.pyx:215
- Return type:
- getTotalDimensions()¶
Return the total size of the approximation space for this system.
Not collective.
See also
petsc.PetscDSGetTotalDimensionSource code at petsc4py/PETSc/DS.pyx:201
- Return type:
- getType()¶
Return the type of the discrete system.
Not collective.
See also
setType,petsc.PetscDSGetTypeSource code at petsc4py/PETSc/DS.pyx:93
- Return type:
- setDiscretisation(f, disc)¶
Set the discretization object for the given field.
Not collective.
- Parameters:
- Return type:
See also
petsc.PetscDSSetDiscretization
- setFromOptions()¶
Set parameters in a
DSfrom the options database.Collective.
See also
Working with PETSc options (TODO),
petsc.PetscDSSetFromOptionsSource code at petsc4py/PETSc/DS.pyx:107
- Return type:
- setType(ds_type)¶
Build a particular type of a discrete system.
Collective.
See also
getType,petsc.PetscDSSetType
- setUp()¶
Construct data structures for the discrete system.
Collective.
See also
petsc.PetscDSSetUpSource code at petsc4py/PETSc/DS.pyx:119
- Return type: