Opm::SurfvolBC< numComponents > Class Template Reference

A class for representing a surface volume boundary condition. More...

#include <BoundaryConditions.hpp>

Inheritance diagram for Opm::SurfvolBC< numComponents >:

Public Types
typedef Dune::FieldVector< double, numComponents >	CompVec
typedef BCBase< CompVec >	Base
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
	SurfvolBC ()
	Default constructor, that makes a Dirichlet condition with all zero component values. More...
	SurfvolBC (Dune::FieldVector< double, numComponents > value)
	Constructor taking a value. More...
CompVec	surfvol () const
	Query a Dirichlet condition. More...
bool	isDirichlet () const
	Forwarding the relevant type query. More...
void	write (std::basic_ostream< charT, traits > &os) const
	Write type and value to an output stream. More...

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

Protected Attributes
BCType	type_
Dune::FieldVector< double, numComponents >	value_

Detailed Description

template<int numComponents>
class Opm::SurfvolBC< numComponents >

A class for representing a surface volume boundary condition.

Member Typedef Documentation

Base

template<int numComponents>

typedef BCBase<CompVec> Opm::SurfvolBC< numComponents >::Base

CompVec

template<int numComponents>

typedef Dune::FieldVector<double, numComponents> Opm::SurfvolBC< numComponents >::CompVec

Member Enumeration Documentation

BCType

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

SurfvolBC() [1/2]

template<int numComponents>

Opm::SurfvolBC< numComponents >::SurfvolBC ( )

inline

Default constructor, that makes a Dirichlet condition with all zero component values.

SurfvolBC() [2/2]

template<int numComponents>

Opm::SurfvolBC< numComponents >::SurfvolBC ( Dune::FieldVector< double, numComponents >  value )

inlineexplicit

Constructor taking a value.

Parameters

value

the condition value.

References Opm::SurfvolBC< numComponents >::isDirichlet().

Member Function Documentation

isDirichlet()

template<int numComponents>

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

inline

Forwarding the relevant type query.

Referenced by Opm::SurfvolBC< numComponents >::SurfvolBC().

isNeumann()

bool Opm::BCBase< Dune::FieldVector< double, numComponents > >::isNeumann ( ) const

inlineprotectedinherited

Type query.

Returns

true if the type is Neumann.

isPeriodic()

bool Opm::BCBase< Dune::FieldVector< double, numComponents > >::isPeriodic ( ) const

inlineprotectedinherited

Type query.

Returns

true if the type is Periodic.

surfvol()

template<int numComponents>

CompVec Opm::SurfvolBC< numComponents >::surfvol ( ) const

inline

Query a Dirichlet condition.

Returns

the boundary saturation value

References Opm::BCBase< T >::value_.

write()

void Opm::BCBase< Dune::FieldVector< double, numComponents > >::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.

Member Data Documentation

type_

BCType Opm::BCBase< Dune::FieldVector< double, numComponents > >::type_

protectedinherited

value_

Dune::FieldVector< double, numComponents > Opm::BCBase< Dune::FieldVector< double, numComponents > >::value_

protectedinherited

---

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

• BoundaryConditions.hpp