ThunderEgg  1.0.0
Public Member Functions | Static Public Member Functions | List of all members
ThunderEgg::Schur::IfaceType< D > Class Template Reference

An enum-style class that represents interface types. More...

#include <IfaceType.h>

Public Member Functions

bool isNormal () const
 Check if this type is Normal. More...
 
bool isCoarseToCoarse () const
 Check if this type is CoarseToCoarse. More...
 
bool isFineToCoarse () const
 Check if this type is FineToCoarse. More...
 
bool isFineToFine () const
 Check if this type is FineToFine. More...
 
bool isCoarseToFine () const
 Check if this type is CoarseToFine. More...
 
 IfaceType ()=default
 Construct a new Iface Type object with the value set to 10 and the orthant set to null.
 
Orthant< D - 1 > getOrthant () const
 Get the Orthant that the finer patch lies on.
 
void setOrthant (Orthant< D - 1 > orthant)
 Set the Orthant that the finer patch lies on.
 
bool operator< (const IfaceType &b) const
 Compare iface type values.
 

Static Public Member Functions

static IfaceType< D > Normal ()
 An interface on a side of a patch with a neighbor at the same refinement level. More...
 
static IfaceType< D > CoarseToCoarse ()
 An interface on a side of a patch with neighbors at a finer refinement level. More...
 
static IfaceType< D > FineToCoarse (Orthant< D - 1 > orth_on_coarse)
 An interface on a side of a patch with a neighbor at a coarser refinement level. More...
 
static IfaceType< D > FineToFine (Orthant< D - 1 > orth_on_coarse)
 An interface on a side of a patch with a neighbor at a coarser refinement level. More...
 
static IfaceType< D > CoarseToFine (Orthant< D - 1 > orthant)
 An interface on a side of a patch with neighbors at a finer refinement level. More...
 

Detailed Description

template<int D>
class ThunderEgg::Schur::IfaceType< D >

An enum-style class that represents interface types.

Template Parameters
Dthe number of cartesian dimensions on a patch

Member Function Documentation

◆ CoarseToCoarse()

template<int D>
static IfaceType<D> ThunderEgg::Schur::IfaceType< D >::CoarseToCoarse ( )
inlinestatic

An interface on a side of a patch with neighbors at a finer refinement level.

This interface lines up with the cells on the coarser patch.

Returns
IfaceType<D> the new IfaceType

◆ CoarseToFine()

template<int D>
static IfaceType<D> ThunderEgg::Schur::IfaceType< D >::CoarseToFine ( Orthant< D - 1 >  orthant)
inlinestatic

An interface on a side of a patch with neighbors at a finer refinement level.

This interface lines up with the cells on the finer patch. The orthant value should be set to the orthant on the coarser patch's side that the finer patch lies on.

Parameters
orthantthe orthant of the fine patch
Returns
IfaceType<D> the new IfaceType

◆ FineToCoarse()

template<int D>
static IfaceType<D> ThunderEgg::Schur::IfaceType< D >::FineToCoarse ( Orthant< D - 1 >  orth_on_coarse)
inlinestatic

An interface on a side of a patch with a neighbor at a coarser refinement level.

This interface lines up with the cells on the coarser patch.

Parameters
orthantthe orthant of the fine patch
Returns
IfaceType<D> the new IfaceType

◆ FineToFine()

template<int D>
static IfaceType<D> ThunderEgg::Schur::IfaceType< D >::FineToFine ( Orthant< D - 1 >  orth_on_coarse)
inlinestatic

An interface on a side of a patch with a neighbor at a coarser refinement level.

This interface lines up with the cells on the finer patch. The orthant value should be set to the orthant on the coarser patch's side that the finer patch lies on.

Parameters
orthantthe orthant of the fine patch
Returns
IfaceType<D> the new IfaceType

◆ isCoarseToCoarse()

template<int D>
bool ThunderEgg::Schur::IfaceType< D >::isCoarseToCoarse ( ) const
inline

Check if this type is CoarseToCoarse.

Returns
if it is CoarseToCoarse

◆ isCoarseToFine()

template<int D>
bool ThunderEgg::Schur::IfaceType< D >::isCoarseToFine ( ) const
inline

Check if this type is CoarseToFine.

Returns
if it is CoarseToFine

◆ isFineToCoarse()

template<int D>
bool ThunderEgg::Schur::IfaceType< D >::isFineToCoarse ( ) const
inline

Check if this type is FineToCoarse.

Returns
if it is FineToCoarse

◆ isFineToFine()

template<int D>
bool ThunderEgg::Schur::IfaceType< D >::isFineToFine ( ) const
inline

Check if this type is FineToFine.

Returns
if it is FineToFine

◆ isNormal()

template<int D>
bool ThunderEgg::Schur::IfaceType< D >::isNormal ( ) const
inline

Check if this type is Normal.

Returns
if it is Normal

◆ Normal()

template<int D>
static IfaceType<D> ThunderEgg::Schur::IfaceType< D >::Normal ( )
inlinestatic

An interface on a side of a patch with a neighbor at the same refinement level.

Returns
IfaceType<D> the new IfaceType
The documentation for this class was generated from the following file: