IPPL (Independent Parallel Particle Layer): ippl::detail::BCondBase< Field > Class Template Reference

IPPL (Independent Parallel Particle Layer)

IPPL

Loading...

Searching...

No Matches

#include <BcTypes.h>

Inheritance diagram for ippl::detail::BCondBase< Field >:

Collaboration diagram for ippl::detail::BCondBase< Field >:

Public Types
using	Layout_t = FieldLayout<Dim>

Public Member Functions
	BCondBase (unsigned int face)
virtual	~BCondBase ()=default
virtual FieldBC	getBCType () const
virtual void	findBCNeighbors (Field &field)=0
virtual void	apply (Field &field)=0
virtual void	assignGhostToPhysical (Field &field)=0
virtual void	write (std::ostream &) const =0
unsigned int	getFace () const
bool	changesPhysicalCells () const

Protected Attributes
unsigned int	face_m
bool	changePhysical_m

Static Private Attributes
static constexpr unsigned	Dim = Field::dim

Detailed Description

template<typename Field>
class ippl::detail::BCondBase< Field >

Definition at line 43 of file BcTypes.h.

Member Typedef Documentation

◆ Layout_t

template<typename Field>

using ippl::detail::BCondBase< Field >::Layout_t = FieldLayout<Dim>

Definition at line 47 of file BcTypes.h.

Constructor & Destructor Documentation

◆ BCondBase()

template<typename Field>

ippl::detail::BCondBase< Field >::BCondBase ( unsigned int face )

Definition at line 23 of file BcTypes.hpp.

References changePhysical_m, and face_m.

Referenced by ippl::NoBcFace< Field >::NoBcFace(), and ippl::PeriodicFace< Field >::PeriodicFace().

Here is the caller graph for this function:

◆ ~BCondBase()

template<typename Field>

virtual ippl::detail::BCondBase< Field >::~BCondBase ( )

virtualdefault

Member Function Documentation

◆ apply()

template<typename Field>

virtual void ippl::detail::BCondBase< Field >::apply ( Field & field )

pure virtual

Implemented in ippl::ExtrapolateFace< Field >, ippl::NoBcFace< Field >, and ippl::PeriodicFace< Field >.

◆ assignGhostToPhysical()

template<typename Field>

virtual void ippl::detail::BCondBase< Field >::assignGhostToPhysical ( Field & field )

pure virtual

Implemented in ippl::ExtrapolateFace< Field >, ippl::NoBcFace< Field >, and ippl::PeriodicFace< Field >.

◆ changesPhysicalCells()

template<typename Field>

bool ippl::detail::BCondBase< Field >::changesPhysicalCells ( ) const

inline

Definition at line 68 of file BcTypes.h.

References changePhysical_m.

◆ findBCNeighbors()

template<typename Field>

virtual void ippl::detail::BCondBase< Field >::findBCNeighbors ( Field & field )

pure virtual

Implemented in ippl::ExtrapolateFace< Field >, ippl::NoBcFace< Field >, and ippl::PeriodicFace< Field >.

◆ getBCType()

template<typename Field>

virtual FieldBC ippl::detail::BCondBase< Field >::getBCType ( ) const

inlinevirtual

Reimplemented in ippl::ConstantFace< Field >, ippl::ExtrapolateFace< Field >, ippl::PeriodicFace< Field >, and ippl::ZeroFace< Field >.

Definition at line 57 of file BcTypes.h.

References ippl::NO_FACE.

◆ getFace()

template<typename Field>

unsigned int ippl::detail::BCondBase< Field >::getFace ( ) const

inline

Definition at line 65 of file BcTypes.h.

References face_m.

◆ write()

template<typename Field>

virtual void ippl::detail::BCondBase< Field >::write ( std::ostream & ) const

pure virtual

Implemented in ippl::ConstantFace< Field >, ippl::ExtrapolateFace< Field >, ippl::NoBcFace< Field >, ippl::PeriodicFace< Field >, and ippl::ZeroFace< Field >.

Referenced by ippl::detail::operator<<().

Here is the caller graph for this function:

Member Data Documentation

◆ changePhysical_m

template<typename Field>

bool ippl::detail::BCondBase< Field >::changePhysical_m

protected

Definition at line 75 of file BcTypes.h.

Referenced by BCondBase(), and changesPhysicalCells().

◆ Dim

template<typename Field>

unsigned ippl::detail::BCondBase< Field >::Dim = Field::dim

staticconstexprprivate

Definition at line 44 of file BcTypes.h.

◆ face_m

template<typename Field>

unsigned int ippl::detail::BCondBase< Field >::face_m

protected

Definition at line 72 of file BcTypes.h.

Referenced by ippl::ExtrapolateFace< Field >::apply(), ippl::PeriodicFace< Field >::apply(), ippl::ExtrapolateFace< Field >::assignGhostToPhysical(), ippl::PeriodicFace< Field >::assignGhostToPhysical(), BCondBase(), ippl::PeriodicFace< Field >::findBCNeighbors(), getFace(), ippl::ConstantFace< Field >::write(), ippl::ExtrapolateFace< Field >::write(), ippl::NoBcFace< Field >::write(), ippl::PeriodicFace< Field >::write(), and ippl::ZeroFace< Field >::write().

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