Opm::RichardsBoundaryRateVector< TypeTag > Class Template Reference

Implements a boundary vector for the fully implicit Richards model. More...

#include <richardsboundaryratevector.hh>

Inheritance diagram for Opm::RichardsBoundaryRateVector< TypeTag >:
Inheritance graph

Public Member Functions

 RichardsBoundaryRateVector ()
 
 RichardsBoundaryRateVector (const Evaluation &value)
 
 RichardsBoundaryRateVector (const RichardsBoundaryRateVector &value)=default
 
RichardsBoundaryRateVectoroperator= (const RichardsBoundaryRateVector &value)=default
 
template<class Context , class FluidState >
void setFreeFlow (const Context &context, unsigned bfIdx, unsigned timeIdx, const FluidState &fluidState)
 Specify a free-flow boundary. More...
 
template<class Context , class FluidState >
void setInFlow (const Context &context, unsigned bfIdx, unsigned timeIdx, const FluidState &fluidState)
 Specify an inflow boundary. More...
 
template<class Context , class FluidState >
void setOutFlow (const Context &context, unsigned bfIdx, unsigned timeIdx, const FluidState &fluidState)
 Specify an outflow boundary. More...
 
void setNoFlow ()
 Specify a no-flow boundary for all conserved quantities. More...
 

Detailed Description

template<class TypeTag>
class Opm::RichardsBoundaryRateVector< TypeTag >

Implements a boundary vector for the fully implicit Richards model.

Constructor & Destructor Documentation

◆ RichardsBoundaryRateVector() [1/3]

template<class TypeTag >
Opm::RichardsBoundaryRateVector< TypeTag >::RichardsBoundaryRateVector ( )
inline

◆ RichardsBoundaryRateVector() [2/3]

template<class TypeTag >
Opm::RichardsBoundaryRateVector< TypeTag >::RichardsBoundaryRateVector ( const Evaluation &  value)
inline

ImmiscibleBoundaryRateVector::ImmiscibleBoundaryRateVector(Scalar)

◆ RichardsBoundaryRateVector() [3/3]

template<class TypeTag >
Opm::RichardsBoundaryRateVector< TypeTag >::RichardsBoundaryRateVector ( const RichardsBoundaryRateVector< TypeTag > &  value)
default

Member Function Documentation

◆ operator=()

template<class TypeTag >
RichardsBoundaryRateVector & Opm::RichardsBoundaryRateVector< TypeTag >::operator= ( const RichardsBoundaryRateVector< TypeTag > &  value)
default

◆ setFreeFlow()

template<class TypeTag >
template<class Context , class FluidState >
void Opm::RichardsBoundaryRateVector< TypeTag >::setFreeFlow ( const Context &  context,
unsigned  bfIdx,
unsigned  timeIdx,
const FluidState &  fluidState 
)
inline

Specify a free-flow boundary.

Parameters
contextThe execution context for which the boundary rate should be specified.
bfIdxThe local space index of the boundary segment.
timeIdxThe index used by the time discretization.
fluidStateThe repesentation of the thermodynamic state of the system on the integration point of the boundary segment.

Referenced by Opm::RichardsBoundaryRateVector< TypeTag >::setInFlow(), and Opm::RichardsBoundaryRateVector< TypeTag >::setOutFlow().

◆ setInFlow()

template<class TypeTag >
template<class Context , class FluidState >
void Opm::RichardsBoundaryRateVector< TypeTag >::setInFlow ( const Context &  context,
unsigned  bfIdx,
unsigned  timeIdx,
const FluidState &  fluidState 
)
inline

Specify an inflow boundary.

An inflow boundary condition is basically a free flow boundary condition that is not prevented from specifying a flow out of the domain.

Parameters
contextThe execution context for which the boundary rate should be specified.
bfIdxThe local space index of the boundary segment.
timeIdxThe index used by the time discretization.
fluidStateThe repesentation of the thermodynamic state of the system on the integration point of the boundary segment.

References Opm::RichardsBoundaryRateVector< TypeTag >::setFreeFlow().

◆ setNoFlow()

template<class TypeTag >
void Opm::RichardsBoundaryRateVector< TypeTag >::setNoFlow ( )
inline

Specify a no-flow boundary for all conserved quantities.

◆ setOutFlow()

template<class TypeTag >
template<class Context , class FluidState >
void Opm::RichardsBoundaryRateVector< TypeTag >::setOutFlow ( const Context &  context,
unsigned  bfIdx,
unsigned  timeIdx,
const FluidState &  fluidState 
)
inline

Specify an outflow boundary.

An outflow boundary condition is basically a free flow boundary condition that is not prevented from specifying a flow into the domain.

Parameters
contextThe execution context for which the boundary rate should be specified.
bfIdxThe local space index of the boundary segment.
timeIdxThe index used by the time discretization.
fluidStateThe repesentation of the thermodynamic state of the system on the integration point of the boundary segment.

References Opm::RichardsBoundaryRateVector< TypeTag >::setFreeFlow().


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