fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm > Class Template Reference

This class references a BoundaryCondition object and acts as an adapter such that it is enabled to be used as an AMReX boundary condition. More...

#include <BoundaryConditionRef.hpp>

Public Member Functions
Constructors
	BoundaryConditionRef ()=delete
	This adapter class is not default constructible. More...
	BoundaryConditionRef (BC &condition, const GriddingAlgorithm &grid, int level)
	Constructs a reference to condition and stores a pointer to grid at refinement level level. More...

Actions
BC *	pointer
	This function fills the ghost layer of the specified MultiFab mf. More...
const GriddingAlgorithm *	gridding
	This function fills the ghost layer of the specified MultiFab mf. More...
int	level
	This function fills the ghost layer of the specified MultiFab mf. More...
void	operator() (::amrex::MultiFab &mf, int dcomp, int ncomp, ::amrex::IntVect const &nghost, ::amrex::Real time, int bccomp)
	This function fills the ghost layer of the specified MultiFab mf. More...

Detailed Description

template<typename BC, typename GriddingAlgorithm>
class fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >

This class references a BoundaryCondition object and acts as an adapter such that it is enabled to be used as an AMReX boundary condition.

Constructor & Destructor Documentation

BoundaryConditionRef() [1/2]

template<typename BC , typename GriddingAlgorithm >

fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::BoundaryConditionRef ( )

delete

This adapter class is not default constructible.

BoundaryConditionRef() [2/2]

template<typename BC , typename GriddingAlgorithm >

fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::BoundaryConditionRef	(	BC &	condition,
		const GriddingAlgorithm &	grid,
		int	level
	)

Constructs a reference to condition and stores a pointer to grid at refinement level level.

Parameters

[in]	condition	The condition that will be invoked
[in]	grid	The reference gridding algorithm can be used if a Geometry object or boundary conditions are needed
[in]	level	The refinement level for which this boundary conditions will be applied to.

Exceptions

Nothing.

Member Function Documentation

operator()()

template<typename BC , typename GriddingAlgorithm >

void fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::operator()	(	::amrex::MultiFab &	mf,
		int	dcomp,
		int	ncomp,
		::amrex::IntVect const &	nghost,
		::amrex::Real	time,
		int	bccomp
	)

This function fills the ghost layer of the specified MultiFab mf.

Exceptions

Throws

any exception that is thrown by the reference boundary condition.

Member Data Documentation

gridding

template<typename BC , typename GriddingAlgorithm >

const GriddingAlgorithm* fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::gridding

This function fills the ghost layer of the specified MultiFab mf.

Exceptions

Throws

any exception that is thrown by the reference boundary condition.

level

template<typename BC , typename GriddingAlgorithm >

int fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::level

This function fills the ghost layer of the specified MultiFab mf.

Exceptions

Throws

any exception that is thrown by the reference boundary condition.

pointer

template<typename BC , typename GriddingAlgorithm >

BC* fub::amrex::BoundaryConditionRef< BC, GriddingAlgorithm >::pointer

This function fills the ghost layer of the specified MultiFab mf.

Exceptions

Throws

any exception that is thrown by the reference boundary condition.

---

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

• BoundaryConditionRef.hpp