A class for building boundary conditions in a uniform way.
More...
#include <BoundaryConditions.hpp>
|
enum | BCType { Dirichlet
, Neumann
, Periodic
} |
| Enum for the allowed boundary condition types. More...
|
|
|
template<typename charT , class traits > |
void | write (std::basic_ostream< charT, traits > &os) const |
| Write type and value to an output stream.
|
|
|
| BCBase () |
| Default constructor, that makes a Neumann condition with value 0.0.
|
|
| BCBase (BCType type, T value) |
| Constructor taking a type and value.
|
|
bool | isDirichlet () const |
| Type query.
|
|
bool | isNeumann () const |
| Type query.
|
|
bool | isPeriodic () const |
| Type query.
|
|
template<typename T>
class Opm::BCBase< T >
A class for building boundary conditions in a uniform way.
◆ BCType
Enum for the allowed boundary condition types.
So far, we support Dirichlet, Neumann and Periodic conditions. In this class, these are just tags, it's up to the code using it to attach meaning to them.
◆ BCBase()
Constructor taking a type and value.
- Parameters
-
type | the condition type. |
value | the condition value. |
◆ isDirichlet()
Type query.
- Returns
- true if the type is Dirichlet.
◆ isNeumann()
Type query.
- Returns
- true if the type is Neumann.
◆ isPeriodic()
Type query.
- Returns
- true if the type is Periodic.
◆ write()
template<typename T >
template<typename charT , class traits >
void Opm::BCBase< T >::write |
( |
std::basic_ostream< charT, traits > & |
os | ) |
const |
|
inline |
Write type and value to an output stream.
- Template Parameters
-
traits | character type. |
traits | character traits. |
- Parameters
-
The documentation for this class was generated from the following file: