Proto  3.2
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Proto::MBLevelOp< OPType, MAP, T, BCType, MEM > Class Template Reference

Level-Scope Operator. More...

#include <Proto_MBLevelOp.H>

Public Types

typedef OPType< T, MAP, MEM > OP
 
typedef BCType< T, OP::numState(), MAP, MEM, PR_CELL > BC
 
typedef BoxData< T, OP::numState(), MEM > StateData
 
typedef BoxData< T, OP::numAux(), MEM > AuxData
 
typedef MBLevelBoxData< T, OP::numState(), MEM, PR_CELL > LevelStateData
 
typedef MBLevelBoxData< T, OP::numAux(), MEM, PR_CELL > LevelAuxData
 

Public Member Functions

T spectralRadius () const
 Spectral Radius. More...
 
 MBLevelOp ()
 
 MBLevelOp (const MBLevelMap< MAP, MEM > &a_map)
 
 MBLevelOp (MBLevelOp< OPType, MAP, T, BCType, MEM > &&a_op)=default
 
MBLevelOp< OPType, MAP, T, BCType, MEM > & operator= (MBLevelOp< OPType, MAP, T, BCType, MEM > &&a_op)=default
 
void define (const MBLevelMap< MAP, MEM > &a_map)
 
void operator() (LevelStateData &a_output, const LevelStateData &a_state, T a_scale=1.0)
 
void operator() (LevelStateData &a_output, const LevelStateData &a_state, const LevelAuxData &a_aux, T a_scale=1.0)
 
OP & operator[] (MBIndex a_index)
 
const OP & operator[] (MBIndex a_index) const
 
void setDiagScale (T a_value)
 
void setFluxScale (T a_value)
 
void setTime (T a_time)
 
void setRKStage (unsigned int a_stage)
 
T diagScale () const
 
T fluxScale () const
 
T time () const
 
unsigned int RKStage () const
 
const MBDisjointBoxLayout & layout () const
 
const OP & operator[] (const LevelIndex &a_index) const
 
void matchFlux (LevelStateData &a_rhs, const LevelStateData &a_state)
 

Static Public Member Functions

static constexpr unsigned int numState ()
 
static constexpr unsigned int numAux ()
 
static Point ghost ()
 
static int order ()
 

Private Attributes

T m_diagScale
 
T m_fluxScale
 
T m_time
 
unsigned int m_rkStage
 
const MBLevelMap< MAP, MEM > * m_map
 
std::vector< OP > m_ops
 

Detailed Description

template<template< typename, typename, MemType > class OPType, typename MAP, typename T, template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
class Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >

Level-Scope Operator.

MBLevelOp contains the necessary tools to apply a user-defined descendent of MBBoxOp on a mapped multiblock level

Template Parameters
OpTypeA MBBoxOp class
MAPA MBMapOp class
TDatatype of the data holder (e.g. int, double, etc.)
BCTypeA LevelBC class
MEMProto::MemType of the data holder

Member Typedef Documentation

◆ OP

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef OPType<T, MAP, MEM> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::OP

◆ BC

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef BCType<T,OP::numState(), MAP, MEM, PR_CELL> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::BC

◆ StateData

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef BoxData<T, OP::numState(), MEM> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::StateData

◆ AuxData

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef BoxData<T, OP::numAux(), MEM> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::AuxData

◆ LevelStateData

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef MBLevelBoxData<T, OP::numState(), MEM, PR_CELL> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::LevelStateData

◆ LevelAuxData

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
typedef MBLevelBoxData<T, OP::numAux(), MEM, PR_CELL> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::LevelAuxData

Constructor & Destructor Documentation

◆ MBLevelOp() [1/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::MBLevelOp ( )
inline

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::spectralRadius().

◆ MBLevelOp() [2/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::MBLevelOp ( const MBLevelMap< MAP, MEM > &  a_map)
inline

◆ MBLevelOp() [3/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::MBLevelOp ( MBLevelOp< OPType, MAP, T, BCType, MEM > &&  a_op)
inlinedefault

Member Function Documentation

◆ numState()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
static constexpr unsigned int Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::numState ( )
inlinestatic

◆ numAux()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
static constexpr unsigned int Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::numAux ( )
inlinestatic

◆ ghost()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
static Point Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::ghost ( )
inlinestatic

◆ order()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
static int Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::order ( )
inlinestatic

◆ spectralRadius()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::spectralRadius ( ) const
inline

Spectral Radius.

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_ops, and Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::MBLevelOp().

◆ operator=()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
MBLevelOp<OPType, MAP, T, BCType, MEM>& Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator= ( MBLevelOp< OPType, MAP, T, BCType, MEM > &&  a_op)
inlinedefault

◆ define()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::define ( const MBLevelMap< MAP, MEM > &  a_map)
inline

◆ operator()() [1/2]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator() ( LevelStateData &  a_output,
const LevelStateData &  a_state,
T  a_scale = 1.0 
)
inline

◆ operator()() [2/2]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator() ( LevelStateData &  a_output,
const LevelStateData &  a_state,
const LevelAuxData &  a_aux,
T  a_scale = 1.0 
)
inline

◆ operator[]() [1/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
OPType< T, MAP, MEM > & Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator[] ( MBIndex  a_index)
inline

◆ operator[]() [2/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
const OPType< T, MAP, MEM > & Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator[] ( MBIndex  a_index) const
inline

◆ setDiagScale()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::setDiagScale ( T  a_value)
inline

◆ setFluxScale()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::setFluxScale ( T  a_value)
inline

◆ setTime()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::setTime ( T  a_time)
inline

◆ setRKStage()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType, MemType MEM>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::setRKStage ( unsigned int  a_stage)
inline

◆ diagScale()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::diagScale ( ) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_diagScale.

◆ fluxScale()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::fluxScale ( ) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_fluxScale.

◆ time()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::time ( ) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_time.

◆ RKStage()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
unsigned int Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::RKStage ( ) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_rkStage.

◆ layout()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
const MBDisjointBoxLayout& Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::layout ( ) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_map.

◆ operator[]() [3/3]

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
const OP& Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator[] ( const LevelIndex &  a_index) const
inline

References Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_ops.

◆ matchFlux()

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
void Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::matchFlux ( LevelStateData &  a_rhs,
const LevelStateData &  a_state 
)
inline

Member Data Documentation

◆ m_diagScale

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_diagScale
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::diagScale().

◆ m_fluxScale

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_fluxScale
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::fluxScale().

◆ m_time

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
T Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_time
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::time().

◆ m_rkStage

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
unsigned int Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_rkStage
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::RKStage().

◆ m_map

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
const MBLevelMap<MAP,MEM>* Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_map
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::layout().

◆ m_ops

template<template< typename, typename, MemType > class OPType, typename MAP , typename T , template< typename, unsigned int, typename, MemType, Centering > class BCType = NullBC, MemType MEM = MEMTYPE_DEFAULT>
std::vector<OP> Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::m_ops
private

Referenced by Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::operator[](), and Proto::MBLevelOp< OPType, MAP, T, BCType, MEM >::spectralRadius().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13