Degree-of-freedom manager that works with multiscale mesh levels.
More...
#include <DofManager.hpp>
Degree-of-freedom manager that works with multiscale mesh levels.
Simplified implementation and capabilities compared to the geos::DofManager.
Definition at line 36 of file DofManager.hpp.
◆ DofManager()
geos::multiscale::DofManager::DofManager |
( |
string |
name | ) |
|
|
explicit |
Constructor.
- Parameters
-
[in] | name | a unique name for this DoF manager |
◆ addField()
Add a field.
- Parameters
-
fieldName | name of the field |
components | number of components |
manager | the mesh manager the field is defined on |
◆ domain()
◆ fieldExists()
bool geos::multiscale::DofManager::fieldExists |
( |
string const & |
name | ) |
const |
Check if string key is already being used.
- Parameters
-
- Returns
- flag true if exists
◆ globalOffset()
globalIndex geos::multiscale::DofManager::globalOffset |
( |
string const & |
fieldName | ) |
const |
- Returns
- global offset of field's block on current processor in the system matrix.
- Parameters
-
[in] | fieldName | name of the field. |
◆ key()
string const& geos::multiscale::DofManager::key |
( |
string const & |
fieldName | ) |
const |
Return the key used to record the field in the DofManager.
- Parameters
-
[in] | fieldName | string the name of the field. |
- Returns
- string indicating name of the field.
◆ localOffset()
localIndex geos::multiscale::DofManager::localOffset |
( |
string const & |
fieldName | ) |
const |
- Returns
- local offset of field's block on current processor in the system matrix.
- Parameters
-
[in] | fieldName | name of the field. |
◆ makeRestrictor()
template<typename MATRIX >
void geos::multiscale::DofManager::makeRestrictor |
( |
string const & |
fieldName, |
|
|
MPI_Comm const & |
comm, |
|
|
bool |
transpose, |
|
|
MATRIX & |
restrictor |
|
) |
| const |
Create a matrix that restricts vectors and matrices to a subset of DOFs.
- Template Parameters
-
MATRIX | type of matrix used for restrictor |
- Parameters
-
fieldName | a fields to select |
comm | the MPI communicator to use in the operator |
transpose | if true , the transpose (prolongation) operator will be created |
restrictor | resulting operator |
- Note
- Can only be called after reorderByRank(), since global DOF indexing is required for the restrictor to make sense.
◆ manager()
- Returns
- reference to the mesh object manager for field
fieldName
.
- Parameters
-
fieldName | name name of the field. |
◆ numComponents() [1/2]
integer geos::multiscale::DofManager::numComponents |
( |
| ) |
const |
- Returns
- number of dof components across all fields.
◆ numComponents() [2/2]
integer geos::multiscale::DofManager::numComponents |
( |
string const & |
fieldName | ) |
const |
- Returns
- number of components in a given field.
- Parameters
-
fieldName | name of the field |
◆ numFields()
std::size_t geos::multiscale::DofManager::numFields |
( |
| ) |
const |
|
inline |
- Returns
- the number of registered fields.
Definition at line 98 of file DofManager.hpp.
◆ numGlobalDofs() [1/2]
globalIndex geos::multiscale::DofManager::numGlobalDofs |
( |
| ) |
const |
- Returns
- total number of dofs across all fields and processors.
◆ numGlobalDofs() [2/2]
globalIndex geos::multiscale::DofManager::numGlobalDofs |
( |
string const & |
fieldName | ) |
const |
- Returns
- number of global dofs of a given field.
- Parameters
-
fieldName | the name of the field |
◆ numLocalDofs() [1/2]
localIndex geos::multiscale::DofManager::numLocalDofs |
( |
| ) |
const |
- Returns
- total number of dofs across all fields on current processor.
◆ numLocalDofs() [2/2]
localIndex geos::multiscale::DofManager::numLocalDofs |
( |
string const & |
fieldName | ) |
const |
- Returns
- number of local dofs of a given field.
- Parameters
-
fieldName | name of the field |
◆ operator=() [1/2]
Defaulted move assignment.
- Returns
◆ operator=() [2/2]
Deleted copy assignment.
- Returns
◆ rankOffset() [1/2]
globalIndex geos::multiscale::DofManager::rankOffset |
( |
| ) |
const |
- Returns
- rank offset of current processor, i.e. total number of dofs on previous processors.
◆ rankOffset() [2/2]
globalIndex geos::multiscale::DofManager::rankOffset |
( |
string const & |
fieldName | ) |
const |
- Returns
- rank offset of given field, i.e. total number of dofs of this field on previous processors.
- Parameters
-
fieldName | name of the field |
◆ setDomain()
Assign a domain.
- Parameters
-
The documentation for this class was generated from the following file: