Level-Scope Operator. More...

#include <Proto_LevelOp.H>

Public Types
typedef OpType< T, MEM >	OP

typedef BCType< T, OP::numState(), MEM, PR_CELL >	BC

typedef BoxData< T, OP::numState(), MEM >	StateData

typedef BoxData< T, OP::numAux(), MEM >	AuxData

typedef LevelBoxData< T, OP::numState(), MEM, PR_CELL >	LevelStateData

typedef LevelBoxData< T, OP::numAux(), MEM, PR_CELL >	LevelAuxData

Public Member Functions
	LevelOp ()
	Default Constructor. More...

	LevelOp (DisjointBoxLayout &a_layout, T a_dx)
	Non-Trivial Constructor. More...

	LevelOp (DisjointBoxLayout &a_layout, Array< T, DIM > a_dx)

	LevelOp (LevelOp< OpType, T, BCType, MEM > &&a_op)=default

LevelOp< OpType, T, BCType, MEM > &	operator= (LevelOp< OpType, T, BCType, MEM > &&a_op)=default

void	define (DisjointBoxLayout &a_layout, T a_dx)
	Lazy Constructor. More...

void	define (DisjointBoxLayout &a_layout, Array< T, DIM > a_dx)

T	spectralRadius () const
	Spectral Radius. More...

void	operator() (LevelStateData &a_output, const LevelStateData &a_state, const LevelAuxData &a_aux, T a_scale=1.0) const
	Apply. More...

void	operator() (LevelStateData &a_output, const LevelStateData &a_state, T a_scale=1.0) const
	Apply. More...

void	applyBC (LevelStateData &a_state) 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

Array< T, DIM >	dx () const

BC &	bc ()

const DisjointBoxLayout &	layout () const

const OP &	operator[] (const LevelIndex &a_index) const

OP &	operator[] (const LevelIndex &a_index)

Static Public Member Functions
static constexpr unsigned int	numState ()

static constexpr unsigned int	numAux ()

static Point	ghost ()
	Ghost Region Size (State) More...

static Point	auxGhost ()
	Ghost Region Size (Auxiliary) More...

static int	order ()

Private Attributes
T	m_diagScale

T	m_fluxScale

T	m_time

unsigned int	m_rkStage

Array< T, DIM >	m_dx

DisjointBoxLayout	m_layout

std::vector< std::shared_ptr< OP > >	m_ops

BC	m_bc

Detailed Description

template<template< typename, MemType > class OpType, typename T, template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>
class Proto::LevelOp< OpType, T, BCType, MEM >

Level-Scope Operator.

LevelOp contains the necessary tools to apply a user-defined descendent of BoxOp on a level.

Template Parameters

OpType	A BoxOp class
T	Datatype of the data holder (e.g. int, double, etc.)
MEM	Proto::MemType of the data holder

Member Typedef Documentation

◆ OP

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef OpType<T, MEM> Proto::LevelOp< OpType, T, BCType, MEM >::OP

◆ BC

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef BCType<T, OP::numState(), MEM, PR_CELL> Proto::LevelOp< OpType, T, BCType, MEM >::BC

◆ StateData

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef BoxData<T, OP::numState(), MEM> Proto::LevelOp< OpType, T, BCType, MEM >::StateData

◆ AuxData

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef BoxData<T, OP::numAux(), MEM> Proto::LevelOp< OpType, T, BCType, MEM >::AuxData

◆ LevelStateData

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef LevelBoxData<T, OP::numState(), MEM, PR_CELL> Proto::LevelOp< OpType, T, BCType, MEM >::LevelStateData

◆ LevelAuxData

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

typedef LevelBoxData<T, OP::numAux(), MEM, PR_CELL> Proto::LevelOp< OpType, T, BCType, MEM >::LevelAuxData

Constructor & Destructor Documentation

◆ LevelOp() [1/4]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

Proto::LevelOp< OpType, T, BCType, MEM >::LevelOp ( )

inline

Default Constructor.

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::order().

◆ LevelOp() [2/4]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

Proto::LevelOp< OpType, T, BCType, MEM >::LevelOp	(	DisjointBoxLayout &	a_layout,
		T	a_dx
	)

inline

Non-Trivial Constructor.

Parameters

dx	Grid spacing

◆ LevelOp() [3/4]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

Proto::LevelOp< OpType, T, BCType, MEM >::LevelOp	(	DisjointBoxLayout &	a_layout,
		Array< T, DIM >	a_dx
	)

inline

◆ LevelOp() [4/4]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

Proto::LevelOp< OpType, T, BCType, MEM >::LevelOp ( LevelOp< OpType, T, BCType, MEM > && a_op )

inlinedefault

Member Function Documentation

◆ numState()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

static constexpr unsigned int Proto::LevelOp< OpType, T, BCType, MEM >::numState ( )

inlinestatic

◆ numAux()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

static constexpr unsigned int Proto::LevelOp< OpType, T, BCType, MEM >::numAux ( )

inlinestatic

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::auxGhost().

◆ ghost()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

static Point Proto::LevelOp< OpType, T, BCType, MEM >::ghost ( )

inlinestatic

Ghost Region Size (State)

Amount of data needed in ghost regions of state variables to apply the operator

◆ auxGhost()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

static Point Proto::LevelOp< OpType, T, BCType, MEM >::auxGhost ( )

inlinestatic

Ghost Region Size (Auxiliary)

Amount of data needed in ghost regions of auxiliary variables to apply the operator

References Proto::LevelOp< OpType, T, BCType, MEM >::numAux(), and Proto::Point::Zeros().

◆ order()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

static int Proto::LevelOp< OpType, T, BCType, MEM >::order ( )

inlinestatic

References Proto::LevelOp< OpType, T, BCType, MEM >::LevelOp().

◆ operator=()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

LevelOp<OpType, T, BCType, MEM>& Proto::LevelOp< OpType, T, BCType, MEM >::operator= ( LevelOp< OpType, T, BCType, MEM > && a_op )

inlinedefault

◆ define() [1/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::define	(	DisjointBoxLayout &	a_layout,
		T	a_dx
	)

inline

Lazy Constructor.

Parameters

dx	Grid spacing

◆ define() [2/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::define	(	DisjointBoxLayout &	a_layout,
		Array< T, DIM >	a_dx
	)

inline

◆ spectralRadius()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::spectralRadius ( ) const

inline

Spectral Radius.

References Proto::LevelOp< OpType, T, BCType, MEM >::m_ops.

◆ operator()() [1/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::operator()	(	LevelStateData &	a_output,
		const LevelStateData &	a_state,
		const LevelAuxData &	a_aux,
		T	a_scale = `1.0`
	)		const

inline

Apply.

Compute L(phi, rho)

Parameters

output	Evaluated operator (output)
state	State variables
aux	Auxiliary variables

◆ operator()() [2/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::operator()	(	LevelStateData &	a_output,
		const LevelStateData &	a_state,
		T	a_scale = `1.0`
	)		const

inline

Apply.

Compute L(phi)

Parameters

output	Evaluated operator (output)
state	State variables

◆ applyBC()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::applyBC ( LevelStateData & a_state ) const

inline

This is a stopgap implementation until I can finish the LevelBC implementation

◆ setDiagScale()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::setDiagScale ( T a_value )

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_rkStage.

◆ setFluxScale()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::setFluxScale ( T a_value )

inline

◆ setTime()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::setTime ( T a_time )

inline

◆ setRKStage()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType, MemType MEM>

void Proto::LevelOp< OpType, T, BCType, MEM >::setRKStage ( unsigned int a_stage )

inline

◆ diagScale()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::diagScale ( ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_diagScale.

◆ fluxScale()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::fluxScale ( ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_fluxScale.

◆ time()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::time ( ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_time.

◆ RKStage()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

unsigned int Proto::LevelOp< OpType, T, BCType, MEM >::RKStage ( ) const

inline

◆ dx()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

Array<T, DIM> Proto::LevelOp< OpType, T, BCType, MEM >::dx ( ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_dx.

◆ bc()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

BC& Proto::LevelOp< OpType, T, BCType, MEM >::bc ( )

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_bc.

◆ layout()

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

const DisjointBoxLayout& Proto::LevelOp< OpType, T, BCType, MEM >::layout ( ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_layout.

◆ operator[]() [1/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

const OP& Proto::LevelOp< OpType, T, BCType, MEM >::operator[] ( const LevelIndex & a_index ) const

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_ops.

◆ operator[]() [2/2]

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

OP& Proto::LevelOp< OpType, T, BCType, MEM >::operator[] ( const LevelIndex & a_index )

inline

References Proto::LevelOp< OpType, T, BCType, MEM >::m_ops.

Member Data Documentation

◆ m_diagScale

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::m_diagScale

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::diagScale().

◆ m_fluxScale

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::m_fluxScale

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::fluxScale().

◆ m_time

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

T Proto::LevelOp< OpType, T, BCType, MEM >::m_time

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::time().

◆ m_rkStage

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

unsigned int Proto::LevelOp< OpType, T, BCType, MEM >::m_rkStage

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::setDiagScale().

◆ m_dx

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

Array<T, DIM> Proto::LevelOp< OpType, T, BCType, MEM >::m_dx

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::dx().

◆ m_layout

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

DisjointBoxLayout Proto::LevelOp< OpType, T, BCType, MEM >::m_layout

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::layout().

◆ m_ops

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

std::vector<std::shared_ptr<OP> > Proto::LevelOp< OpType, T, BCType, MEM >::m_ops

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::operator[](), and Proto::LevelOp< OpType, T, BCType, MEM >::spectralRadius().

◆ m_bc

template<template< typename, MemType > class OpType, typename T , template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>

BC Proto::LevelOp< OpType, T, BCType, MEM >::m_bc

private

Referenced by Proto::LevelOp< OpType, T, BCType, MEM >::bc().

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

Proto_LevelOp.H

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<template< typename, MemType > class OpType, typename T, template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT> class Proto::LevelOp< OpType, T, BCType, MEM >

Member Typedef Documentation

◆ OP

◆ BC

◆ StateData

◆ AuxData

◆ LevelStateData

◆ LevelAuxData

Constructor & Destructor Documentation

◆ LevelOp() [1/4]

◆ LevelOp() [2/4]

◆ LevelOp() [3/4]

◆ LevelOp() [4/4]

Member Function Documentation

◆ numState()

◆ numAux()

◆ ghost()

◆ auxGhost()

◆ order()

◆ operator=()

◆ define() [1/2]

◆ define() [2/2]

◆ spectralRadius()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ applyBC()

◆ setDiagScale()

◆ setFluxScale()

◆ setTime()

◆ setRKStage()

◆ diagScale()

◆ fluxScale()

◆ time()

◆ RKStage()

◆ dx()

◆ bc()

◆ layout()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Member Data Documentation

◆ m_diagScale

◆ m_fluxScale

◆ m_time

◆ m_rkStage

◆ m_dx

◆ m_layout

◆ m_ops

◆ m_bc

template<template< typename, MemType > class OpType, typename T, template< typename, unsigned int, MemType, Centering > class BCType = PeriodicBC, MemType MEM = MEMTYPE_DEFAULT>
class Proto::LevelOp< OpType, T, BCType, MEM >