Class IBRodForceSpec encapsulates the data necessary to compute the forces generated by a network of Kirchhoff rods at a single node of the Lagrangian mesh.
More...
#include </home/runner/work/IBAMR/IBAMR/include/ibamr/IBRodForceSpec.h>
|
static const int | NUM_MATERIAL_PARAMS = 10 |
|
static int | STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID() |
|
Class IBRodForceSpec encapsulates the data necessary to compute the forces generated by a network of Kirchhoff rods at a single node of the Lagrangian mesh.
◆ getMasterNodeIndex() [1/2]
int & IBAMR::IBRodForceSpec::getMasterNodeIndex |
( |
| ) |
|
|
inline |
- Returns
- A non-const reference to the master node index.
◆ getMasterNodeIndex() [2/2]
const int & IBAMR::IBRodForceSpec::getMasterNodeIndex |
( |
| ) |
const |
|
inline |
- Returns
- A const reference to the master node index.
◆ getMaterialParams() [1/2]
std::vector< std::array< double, IBRodForceSpec::NUM_MATERIAL_PARAMS > > & IBAMR::IBRodForceSpec::getMaterialParams |
( |
| ) |
|
|
inline |
- Returns
- A non-const reference to the material parameters of the rods attached to the master node.
◆ getMaterialParams() [2/2]
const std::vector< std::array< double, IBRodForceSpec::NUM_MATERIAL_PARAMS > > & IBAMR::IBRodForceSpec::getMaterialParams |
( |
| ) |
const |
|
inline |
- Returns
- A const reference to the material parameters of the rods attached to the master node.
◆ getNextNodeIndices() [1/2]
std::vector< int > & IBAMR::IBRodForceSpec::getNextNodeIndices |
( |
| ) |
|
|
inline |
- Returns
- A non-const reference to the next node indices for the rods attached to the master node.
◆ getNextNodeIndices() [2/2]
const std::vector< int > & IBAMR::IBRodForceSpec::getNextNodeIndices |
( |
| ) |
const |
|
inline |
- Returns
- A const reference to the next node indices for the rods attached to the master node.
◆ getNumberOfRods()
unsigned int IBAMR::IBRodForceSpec::getNumberOfRods |
( |
| ) |
const |
|
inline |
- Returns
- The number of rods attached to the master node.
◆ registerWithStreamableManager()
void IBAMR::IBRodForceSpec::registerWithStreamableManager |
( |
| ) |
|
|
static |
Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBRodForceSpec objects are created.
- Note
- This method is collective on all MPI processes. This is done to ensure that all processes employ the same class ID for the IBRodForceSpec class.
◆ STREAMABLE_CLASS_ID
int IBAMR::IBRodForceSpec::STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID() |
|
static |
The documentation for this class was generated from the following files:
- /home/runner/work/IBAMR/IBAMR/include/ibamr/IBRodForceSpec.h
- /home/runner/work/IBAMR/IBAMR/include/ibamr/private/IBRodForceSpec-inl.h
- /home/runner/work/IBAMR/IBAMR/src/IB/IBRodForceSpec.cpp