Opm::SatBC Class Reference

A class for representing a saturation boundary condition. More...

#include <BoundaryConditions.hpp>

Inheritance diagram for Opm::SatBC:

Public Types
enum	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. More...

Public Member Functions
	SatBC ()
	Default constructor, that makes a Dirichlet condition with value 1.0. More...
	SatBC (BCType type, double value)
	Constructor taking a type and value. More...
double	saturation () const
	Query a Dirichlet condition. More...
double	saturationDifference () const
	Query a Periodic condition. More...
void	write (std::basic_ostream< charT, traits > &os) const
	Write type and value to an output stream. More...

Protected Member Functions
bool	isDirichlet () const
	Type query. More...
bool	isNeumann () const
	Type query. More...
bool	isPeriodic () const
	Type query. More...

Protected Attributes
BCType	type_
double	value_

Detailed Description

A class for representing a saturation boundary condition.

Member Enumeration Documentation

enum Opm::BCBase::BCType

inherited

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.

Constructor & Destructor Documentation

Opm::SatBC::SatBC ( )

inline

Default constructor, that makes a Dirichlet condition with value 1.0.

Opm::SatBC::SatBC ( BCType  type, double  value  )

inline

Constructor taking a type and value.

Parameters

type	the condition type.
value	the condition value.

References Opm::BCBase< double >::isDirichlet(), and Opm::BCBase< double >::isPeriodic().

Member Function Documentation

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

inlineprotectedinherited

Type query.

Returns

true if the type is Dirichlet.

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

Referenced by Opm::FlowBC::FlowBC(), Opm::FlowBC::pressure(), SatBC(), and saturation().

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

inlineprotectedinherited

Type query.

Returns

true if the type is Neumann.

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

Referenced by Opm::FlowBC::FlowBC(), and Opm::FlowBC::outflux().

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

inlineprotectedinherited

Type query.

Returns

true if the type is Periodic.

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

Referenced by Opm::FlowBC::FlowBC(), Opm::FlowBC::pressureDifference(), SatBC(), and saturationDifference().

double Opm::SatBC::saturation ( ) const

inline

Query a Dirichlet condition.

Returns

the boundary saturation value

References Opm::BCBase< double >::isDirichlet(), and Opm::BCBase< double >::value_.

double Opm::SatBC::saturationDifference ( ) const

inline

Query a Periodic condition.

Returns

the saturation difference value.

References Opm::BCBase< double >::isPeriodic(), and Opm::BCBase< double >::value_.

void Opm::BCBase< double >::write ( std::basic_ostream< charT, traits > &  os ) const

inlineinherited

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

BCType Opm::BCBase< double >::type_

protectedinherited

double Opm::BCBase< double >::value_

protectedinherited

Referenced by Opm::FlowBC::outflux(), Opm::FlowBC::pressure(), Opm::FlowBC::pressureDifference(), saturation(), and saturationDifference().

---

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

• BoundaryConditions.hpp