OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
AmrPeriodicBoundary< Level > Class Template Reference

#include <AmrPeriodicBoundary.h>

Inheritance diagram for AmrPeriodicBoundary< Level >:
Collaboration diagram for AmrPeriodicBoundary< Level >:

Public Types

typedef Level::umap_t umap_t
typedef Level::lo_t lo_t
typedef Level::go_t go_t
typedef Level::scalar_t scalar_t
typedef amr::AmrIntVect_t AmrIntVect_t
typedef Level::basefab_t basefab_t

Public Member Functions

 AmrPeriodicBoundary ()
void apply (const AmrIntVect_t &iv, const lo_t &dir, umap_t &map, const scalar_t &value, Level *mglevel, const go_t *nr)
bool isBoundary (const AmrIntVect_t &iv, const go_t *nr) const
bool isBoundary (const AmrIntVect_t &iv, const lo_t &dir, const go_t *nr) const
const go_tgetNumberOfPoints () const

Private Attributes

const go_t nPoints_m
 Number of points used for boundary.

Detailed Description

template<class Level>
class AmrPeriodicBoundary< Level >

Definition at line 27 of file AmrPeriodicBoundary.h.

Member Typedef Documentation

◆ AmrIntVect_t

template<class Level>
typedef amr::AmrIntVect_t AmrPeriodicBoundary< Level >::AmrIntVect_t

Definition at line 34 of file AmrPeriodicBoundary.h.

◆ basefab_t

template<class Level>
typedef Level::basefab_t AmrBoundary< Level >::basefab_t
inherited

Definition at line 36 of file AmrBoundary.h.

◆ go_t

template<class Level>
typedef Level::go_t AmrPeriodicBoundary< Level >::go_t

Definition at line 32 of file AmrPeriodicBoundary.h.

◆ lo_t

template<class Level>
typedef Level::lo_t AmrPeriodicBoundary< Level >::lo_t

Definition at line 31 of file AmrPeriodicBoundary.h.

◆ scalar_t

template<class Level>
typedef Level::scalar_t AmrPeriodicBoundary< Level >::scalar_t

Definition at line 33 of file AmrPeriodicBoundary.h.

◆ umap_t

template<class Level>
typedef Level::umap_t AmrPeriodicBoundary< Level >::umap_t

Definition at line 30 of file AmrPeriodicBoundary.h.

Constructor & Destructor Documentation

◆ AmrPeriodicBoundary()

template<class Level>
AmrPeriodicBoundary< Level >::AmrPeriodicBoundary ( )
inline

Definition at line 38 of file AmrPeriodicBoundary.h.

References AmrBoundary< Level >::AmrBoundary().

Here is the call graph for this function:

Member Function Documentation

◆ apply()

template<class Level>
void AmrPeriodicBoundary< Level >::apply ( const AmrIntVect_t & iv,
const lo_t & dir,
umap_t & map,
const scalar_t & value,
Level * mglevel,
const go_t * nr )
virtual

Apply boundary in a certain direction.

Parameters
ivis the cell where we want to have the boundary value
dirdirection of physical / mesh boundary
mapwith indices global matrix indices and matrix values
valuematrix entry (coefficients)
valueof matrix entry that is supposed for index
nris the number of grid points

Implements AmrBoundary< Level >.

Definition at line 50 of file AmrPeriodicBoundary.h.

References nr.

◆ getNumberOfPoints()

template<class Level>
const go_t & AmrBoundary< Level >::getNumberOfPoints ( ) const
inlineinherited
Returns
the number of stencil points required

Definition at line 88 of file AmrBoundary.h.

References nPoints_m.

◆ isBoundary() [1/2]

template<class Level>
bool AmrBoundary< Level >::isBoundary ( const AmrIntVect_t & iv,
const go_t * nr ) const
inlineinherited

Check if we are on the physical boundary (all directions)

Parameters
ivcell to check
nris the number of grid points

Definition at line 52 of file AmrBoundary.h.

References isBoundary(), and nr.

Referenced by isBoundary().

Here is the call graph for this function:

◆ isBoundary() [2/2]

template<class Level>
bool AmrBoundary< Level >::isBoundary ( const AmrIntVect_t & iv,
const lo_t & dir,
const go_t * nr ) const
inlineinherited

Check if we are on the physical boundary (certain direction)

Parameters
ivcell to check
nris the number of grid points

Definition at line 63 of file AmrBoundary.h.

References nr.

Member Data Documentation

◆ nPoints_m

template<class Level>
const go_t AmrBoundary< Level >::nPoints_m
privateinherited

Number of points used for boundary.

Definition at line 93 of file AmrBoundary.h.

Referenced by AmrBoundary(), and getNumberOfPoints().


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