The ContactModelState class holds necessary information to communicate back and forth between the code (e.g., PFC) and the contact model. More...
#include <contactmodel.h>
Inheritance diagram for cmodelsxd::ContactModelState:
Public Member Functions | |
| ContactModelState () | |
| Constructor. | |
| virtual | ~ContactModelState () |
| Destructor. | |
| virtual const IProgram * | getProgram () const =0 |
| Return a const pointer to the IPrgram interface. | |
| bool | setActive (bool b=true) |
| Set the activity state of the contact. | |
| bool | setCouldBeActive (bool b=true) |
| Set the activity state of the contact. | |
| bool | setActivated (bool b=true) |
| Set the activity state of the contact. | |
| bool | isActive () const |
| Returns true if the contact state is active. | |
| bool | isInactive () const |
| Returns true if the contact state is inactive. | |
| bool | activated () const |
| Returns true if the contact state is activated. | |
| bool | couldBeActive () const |
| Returns true if the contact could be activate in subsequent steps. | |
Public Attributes | |
| uint32 | activeState_ = 0 |
| Current activity state flag. | |
| bool | trackEnergy_ = false |
| indicate whether energy tracking is activated | |
Detailed Description
The ContactModelState class holds necessary information to communicate back and forth between the code (e.g., PFC) and the contact model.
Member Function Documentation
◆ getProgram()
|
pure virtual |
Return a const pointer to the IPrgram interface.
Implemented in cmodelsxd::ContactModelFluidState, and cmodelsxd::ContactModelThermalState.
The documentation for this class was generated from the following file:
- C:/Source/itasca-suite/common/contactmodel/src/contactmodel.h
