Opm::BCBase< T > Class Template Reference

A class for building boundary conditions in a uniform way. More...

#include <BoundaryConditions.hpp>

Inheritance diagram for Opm::BCBase< T >:

Public Types
enum	BCType { Dirichlet , Neumann , Periodic }
	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. More...

Public Member Functions
template<typename charT , class traits >
void	write (std::basic_ostream< charT, traits > &os) const
	Write type and value to an output stream. More...

Protected Member Functions
	BCBase ()
	Default constructor, that makes a Neumann condition with value 0.0. More...
	BCBase (BCType type, T value)
	Constructor taking a type and value. More...
bool	isDirichlet () const
	Type query. More...
bool	isNeumann () const
	Type query. More...
bool	isPeriodic () const
	Type query. More...

Protected Attributes
BCType	type_
T	value_

Detailed Description

template<typename T>
class Opm::BCBase< T >

A class for building boundary conditions in a uniform way.

Member Enumeration Documentation

BCType

template<typename T >

enum Opm::BCBase::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.

Enumerator
Dirichlet
Neumann
Periodic

Constructor & Destructor Documentation

BCBase() [1/2]

template<typename T >

Opm::BCBase< T >::BCBase ( )

inlineprotected

Default constructor, that makes a Neumann condition with value 0.0.

BCBase() [2/2]

template<typename T >

Opm::BCBase< T >::BCBase ( BCType  type, T  value  )

inlineprotected

Constructor taking a type and value.

Parameters

type	the condition type.
value	the condition value.

Member Function Documentation

isDirichlet()

template<typename T >

bool Opm::BCBase< T >::isDirichlet ( ) const

inlineprotected

Type query.

Returns

true if the type is Dirichlet.

References Opm::BCBase< T >::Dirichlet, and Opm::BCBase< T >::type_.

Referenced by Opm::TpfaCompressible< GridInterface, RockInterface, FluidInterface, WellsInterface, BCInterface >::setup().

isNeumann()

template<typename T >

bool Opm::BCBase< T >::isNeumann ( ) const

inlineprotected

Type query.

Returns

true if the type is Neumann.

References Opm::BCBase< T >::Neumann, and Opm::BCBase< T >::type_.

Referenced by Opm::TpfaCompressible< GridInterface, RockInterface, FluidInterface, WellsInterface, BCInterface >::setup(), and Opm::storeFlowCond().

isPeriodic()

template<typename T >

bool Opm::BCBase< T >::isPeriodic ( ) const

inlineprotected

Type query.

Returns

true if the type is Periodic.

References Opm::BCBase< T >::Periodic, and Opm::BCBase< T >::type_.

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

os	output stream.

References Opm::BCBase< T >::type_, and Opm::BCBase< T >::value_.

Member Data Documentation

type_

template<typename T >

BCType Opm::BCBase< T >::type_

protected

Referenced by Opm::BCBase< T >::isDirichlet(), Opm::BCBase< T >::isNeumann(), Opm::BCBase< T >::isPeriodic(), and Opm::BCBase< T >::write().

value_

template<typename T >

T Opm::BCBase< T >::value_

protected

Referenced by Opm::SurfvolBC< numComponents >::surfvol(), and Opm::BCBase< T >::write().

---

The documentation for this class was generated from the following file:

• BoundaryConditions.hpp