Interface for scalar fields. See Continuum for more information.
More...
#include <continuum_interface.h>
Inheritance diagram for bdm::ScalarField:
Collaboration diagram for bdm::ScalarField:
Public Member Functions | |
| ScalarField ()=default | |
| ScalarField (const TRootIOCtor *) | |
| ~ScalarField () override=default | |
| virtual real_t | GetValue (const Real3 &position) const =0 |
| Returns the value of the scalar field at the given position. More... | |
| virtual Real3 | GetGradient (const Real3 &position) const =0 |
| Returns the gradient of the scalar field at the given position. More... | |
| BDM_CLASS_DEF_OVERRIDE (ScalarField, 1) | |
 Public Member Functions inherited from bdm::Continuum | |
| Continuum ()=default | |
| Continuum (const TRootIOCtor *) | |
| virtual | ~Continuum ()=default |
| void | IntegrateTimeAsynchronously (real_t dt) |
| virtual void | Initialize ()=0 |
| virtual void | Update ()=0 |
| virtual void | Step (real_t dt)=0 |
| int | GetContinuumId () const |
| Returns the ID of the continuum. More... | |
| void | SetContinuumId (int id) |
| Sets the ID of the continuum. More... | |
| const std::string & | GetContinuumName () const |
| Returns the name of the continuum. More... | |
| void | SetContinuumName (const std::string &name) |
| Sets the name of the continuum. More... | |
| real_t | GetSimulatedTime () const |
| Returns the time simulated by the continuum. More... | |
| void | SetTimeStep (real_t dt) |
| real_t | GetTimeStep () const |
| Returns the time step for the continuum. More... | |
Detailed Description
Interface for scalar fields. See Continuum for more information.
Definition at line 132 of file continuum_interface.h.
Constructor & Destructor Documentation
◆ ScalarField() [1/2]
|
default |
◆ ScalarField() [2/2]
|
inlineexplicit |
Definition at line 135 of file continuum_interface.h.
◆ ~ScalarField()
|
overridedefault |
Member Function Documentation
◆ BDM_CLASS_DEF_OVERRIDE()
| bdm::ScalarField::BDM_CLASS_DEF_OVERRIDE | ( | ScalarField | , |
| 1 | |||
| ) |
◆ GetGradient()
Returns the gradient of the scalar field at the given position.
Implemented in bdm::DiffusionGrid.
◆ GetValue()
Returns the value of the scalar field at the given position.
Implemented in bdm::DiffusionGrid.
The documentation for this class was generated from the following file:
- core/diffusion/continuum_interface.h
