Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents > Class Template Reference

#include <BoundaryConditions.hpp>

Inheritance diagram for Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >:
Inheritance graph

Public Types

typedef boost::mpl::if_c< FC, std::vector< FlowBC >, DummyVec< FlowBC > >::type FlowConds
 
typedef boost::mpl::if_c< SC, std::vector< SatBC >, DummyVec< SatBC > >::type SatConds
 
typedef boost::mpl::if_c< ZC, std::vector< SurfvolBC< numComponents > >, DummyVec< SurfvolBC< numComponents > > >::type SurfvolConds
 

Public Member Functions

 BasicBoundaryConditions ()
 
 BasicBoundaryConditions (int num_different_boundary_ids)
 
void resize (int new_size)
 
bool empty () const
 
void clear ()
 
int size () const
 
FlowBCflowCond (int i)
 
const FlowBCflowCond (int i) const
 
template<class BoundaryFace >
const FlowBCflowCond (const BoundaryFace &bf) const
 
SatBCsatCond (int i)
 
const SatBCsatCond (int i) const
 
template<class BoundaryFace >
const SatBCsatCond (const BoundaryFace &bf) const
 
SurfvolBC< numComponents > & surfvolCond (int i)
 
const SurfvolBC< numComponents > & surfvolCond (int i) const
 
template<class BoundaryFace >
const SurfvolBC< numComponents > & surfvolCond (const BoundaryFace &bf) const
 
template<typename charT , class traits >
void write (std::basic_ostream< charT, traits > &os) const
 
void setPeriodicPartners (int boundary_id_1, int boundary_id_2)
 
int getPeriodicPartner (int boundary_id) const
 
void setCanonicalBoundaryId (int boundary_id, int canonical_bid)
 
int getCanonicalBoundaryId (int boundary_id) const
 

Static Public Attributes

static const bool HasFlowConds = FC
 
static const bool HasSatConds = SC
 
static const bool HasSurfvolConds = SC
 

Member Typedef Documentation

◆ FlowConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
typedef boost::mpl::if_c<FC,std::vector<FlowBC>,DummyVec<FlowBC>>::type Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::FlowConds

◆ SatConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
typedef boost::mpl::if_c<SC,std::vector<SatBC>,DummyVec<SatBC>>::type Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::SatConds

◆ SurfvolConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
typedef boost::mpl::if_c<ZC,std::vector<SurfvolBC<numComponents>>,DummyVec<SurfvolBC<numComponents>>>::type Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::SurfvolConds

Constructor & Destructor Documentation

◆ BasicBoundaryConditions() [1/2]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::BasicBoundaryConditions ( )
inline

◆ BasicBoundaryConditions() [2/2]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::BasicBoundaryConditions ( int  num_different_boundary_ids)
inline

Member Function Documentation

◆ clear()

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
void Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::clear ( )
inline

◆ empty()

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
bool Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::empty ( ) const
inline

◆ flowCond() [1/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
template<class BoundaryFace >
const FlowBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::flowCond ( const BoundaryFace &  bf) const
inline

◆ flowCond() [2/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
FlowBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::flowCond ( int  i)
inline

◆ flowCond() [3/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const FlowBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::flowCond ( int  i) const
inline

◆ getCanonicalBoundaryId()

int Opm::PeriodicConditionHandler::getCanonicalBoundaryId ( int  boundary_id) const
inlineinherited

◆ getPeriodicPartner()

int Opm::PeriodicConditionHandler::getPeriodicPartner ( int  boundary_id) const
inlineinherited

◆ resize()

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
void Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::resize ( int  new_size)
inline

◆ satCond() [1/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
template<class BoundaryFace >
const SatBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::satCond ( const BoundaryFace &  bf) const
inline

◆ satCond() [2/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
SatBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::satCond ( int  i)
inline

◆ satCond() [3/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const SatBC & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::satCond ( int  i) const
inline

◆ setCanonicalBoundaryId()

void Opm::PeriodicConditionHandler::setCanonicalBoundaryId ( int  boundary_id,
int  canonical_bid 
)
inlineinherited

◆ setPeriodicPartners()

void Opm::PeriodicConditionHandler::setPeriodicPartners ( int  boundary_id_1,
int  boundary_id_2 
)
inlineinherited

◆ size()

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
int Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::size ( ) const
inline

◆ surfvolCond() [1/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
template<class BoundaryFace >
const SurfvolBC< numComponents > & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::surfvolCond ( const BoundaryFace &  bf) const
inline

◆ surfvolCond() [2/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
SurfvolBC< numComponents > & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::surfvolCond ( int  i)
inline

◆ surfvolCond() [3/3]

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const SurfvolBC< numComponents > & Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::surfvolCond ( int  i) const
inline

◆ write()

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
template<typename charT , class traits >
void Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::write ( std::basic_ostream< charT, traits > &  os) const
inline

Member Data Documentation

◆ HasFlowConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const bool Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::HasFlowConds = FC
static

◆ HasSatConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const bool Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::HasSatConds = SC
static

◆ HasSurfvolConds

template<bool FC = false, bool SC = false, bool ZC = false, int numComponents = 3>
const bool Opm::BasicBoundaryConditions< FC, SC, ZC, numComponents >::HasSurfvolConds = SC
static

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