amrex::Periodicity Class Reference

This provides length of period for periodic domains. 0 means it is not periodic in that direction. It is also assumed that the periodic domain starts with index 0. More...

#include <AMReX_Periodicity.H>

Public Member Functions
	Periodicity () noexcept
	Periodicity (const IntVect &v) noexcept
bool	isAnyPeriodic () const noexcept
bool	isAllPeriodic () const noexcept
bool	isPeriodic (int dir) const noexcept
bool	operator== (const Periodicity &rhs) const noexcept
Box	Domain () const noexcept
	Cell-centered domain Box "infinitely" long in non-periodic directions.
IntVect const &	intVect () const
std::vector< IntVect >	shiftIntVect (IntVect const &nghost=IntVect(0)) const

Static Public Member Functions
static const Periodicity &	NonPeriodic () noexcept

Detailed Description

This provides length of period for periodic domains. 0 means it is not periodic in that direction. It is also assumed that the periodic domain starts with index 0.

Constructor & Destructor Documentation

Periodicity() [1/2]

amrex::Periodicity::Periodicity ( )

inlinenoexcept

Periodicity() [2/2]

amrex::Periodicity::Periodicity ( const IntVect & v )

inlineexplicitnoexcept

Member Function Documentation

Domain()

Box amrex::Periodicity::Domain ( ) const

nodiscardnoexcept

Cell-centered domain Box "infinitely" long in non-periodic directions.

intVect()

IntVect const & amrex::Periodicity::intVect ( ) const

inlinenodiscard

isAllPeriodic()

bool amrex::Periodicity::isAllPeriodic ( ) const

inlinenodiscardnoexcept

isAnyPeriodic()

bool amrex::Periodicity::isAnyPeriodic ( ) const

inlinenodiscardnoexcept

isPeriodic()

bool amrex::Periodicity::isPeriodic ( int dir ) const

inlinenodiscardnoexcept

NonPeriodic()

const Periodicity & amrex::Periodicity::NonPeriodic ( )

staticnoexcept

operator==()

bool amrex::Periodicity::operator== ( const Periodicity & rhs ) const

inlinenoexcept

shiftIntVect()

std::vector< IntVect > amrex::Periodicity::shiftIntVect ( IntVect const & nghost = IntVect(0) ) const

nodiscard

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_Periodicity.H
• /home/runner/work/amrex/amrex/Src/Base/AMReX_Periodicity.cpp