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

IPPL (Independent Parallel Particle Layer)

IPPL

Loading...

Searching...

No Matches

#include <BcTypes.h>

Inheritance diagram for ippl::ConstantFace< Field >:

Collaboration diagram for ippl::ConstantFace< Field >:

Public Types
using	base_type = detail::BCondBase<Field>
using	Layout_t = typename detail::BCondBase<Field>::Layout_t

Public Member Functions
	ConstantFace (unsigned int face, T constant)
virtual FieldBC	getBCType () const
virtual void	write (std::ostream &out) const
virtual void	findBCNeighbors (Field &)
virtual void	apply (Field &field)
virtual void	assignGhostToPhysical (Field &field)
const T &	getOffset () const
const T &	getSlope () const
unsigned int	getFace () const
bool	changesPhysicalCells () const

Protected Attributes
T	offset_m
T	slope_m
unsigned int	face_m
bool	changePhysical_m

Private Types
using	T = typename Field::value_type

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

Detailed Description

template<typename Field>
class ippl::ConstantFace< Field >

Definition at line 133 of file BcTypes.h.

Member Typedef Documentation

◆ base_type

template<typename Field>

using ippl::ExtrapolateFace< Field >::base_type = detail::BCondBase<Field>

inherited

Definition at line 93 of file BcTypes.h.

◆ Layout_t

template<typename Field>

using ippl::ExtrapolateFace< Field >::Layout_t = typename detail::BCondBase<Field>::Layout_t

inherited

Definition at line 94 of file BcTypes.h.

◆ T

template<typename Field>

using ippl::ConstantFace< Field >::T = typename Field::value_type

private

Definition at line 134 of file BcTypes.h.

Constructor & Destructor Documentation

◆ ConstantFace()

template<typename Field>

ippl::ConstantFace< Field >::ConstantFace	(	unsigned int	face,
		T	constant )

inline

Definition at line 137 of file BcTypes.h.

References ippl::ExtrapolateFace< Field >::ExtrapolateFace().

Referenced by ippl::ZeroFace< Field >::ZeroFace().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ apply()

template<typename Field>

void ippl::ExtrapolateFace< Field >::apply ( Field & field )

virtualinherited

Implements ippl::detail::BCondBase< Field >.

Definition at line 36 of file BcTypes.hpp.

References ippl::apply(), ippl::createRangePolicy(), Dim, ippl::detail::BCondBase< Field >::face_m, ippl::BareField< T, Dim, ViewArgs >::getCommunicator(), ippl::FieldLayout< Dim >::getHostLocalDomains(), ippl::BareField< T, Dim, ViewArgs >::getLayout(), ippl::BareField< T, Dim, ViewArgs >::getNghost(), ippl::BareField< T, Dim, ViewArgs >::getView(), ippl::max, ippl::min(), offset_m, ippl::parallel_for(), and slope_m.

Here is the call graph for this function:

◆ assignGhostToPhysical()

template<typename Field>

void ippl::ExtrapolateFace< Field >::assignGhostToPhysical ( Field & field )

virtualinherited

Implements ippl::detail::BCondBase< Field >.

Definition at line 408 of file BcTypes.hpp.

References ippl::apply(), ippl::createRangePolicy(), Dim, ippl::detail::BCondBase< Field >::face_m, ippl::BareField< T, Dim, ViewArgs >::getLayout(), ippl::BareField< T, Dim, ViewArgs >::getNghost(), ippl::BareField< T, Dim, ViewArgs >::getView(), ippl::max, ippl::min(), and ippl::parallel_for().

Here is the call graph for this function:

◆ changesPhysicalCells()

template<typename Field>

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

inlineinherited

Definition at line 68 of file BcTypes.h.

References changePhysical_m.

◆ findBCNeighbors()

template<typename Field>

virtual void ippl::ExtrapolateFace< Field >::findBCNeighbors ( Field & )

inlinevirtualinherited

Implements ippl::detail::BCondBase< Field >.

Definition at line 105 of file BcTypes.h.

◆ getBCType()

template<typename Field>

virtual FieldBC ippl::ConstantFace< Field >::getBCType ( ) const

inlinevirtual

Reimplemented from ippl::ExtrapolateFace< Field >.

Reimplemented in ippl::ZeroFace< Field >.

Definition at line 140 of file BcTypes.h.

References ippl::CONSTANT_FACE.

◆ getFace()

template<typename Field>

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

inlineinherited

Definition at line 65 of file BcTypes.h.

References face_m.

◆ getOffset()

template<typename Field>

const T & ippl::ExtrapolateFace< Field >::getOffset ( ) const

inlineinherited

Definition at line 111 of file BcTypes.h.

References offset_m.

◆ getSlope()

template<typename Field>

const T & ippl::ExtrapolateFace< Field >::getSlope ( ) const

inlineinherited

Definition at line 112 of file BcTypes.h.

References slope_m.

◆ write()

template<typename Field>

void ippl::ConstantFace< Field >::write ( std::ostream & out ) const

virtual

Reimplemented from ippl::ExtrapolateFace< Field >.

Reimplemented in ippl::ZeroFace< Field >.

Definition at line 120 of file BcTypes.hpp.

References ippl::detail::BCondBase< Field >::face_m, and ippl::ExtrapolateFace< Field >::offset_m.

Member Data Documentation

◆ changePhysical_m

template<typename Field>

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

protectedinherited

Definition at line 75 of file BcTypes.h.

Referenced by BCondBase(), and changesPhysicalCells().

◆ Dim

template<typename Field>

unsigned ippl::ExtrapolateFace< Field >::Dim = Field::dim

staticconstexprprivateinherited

Definition at line 85 of file BcTypes.h.

Referenced by apply(), and assignGhostToPhysical().

◆ face_m

template<typename Field>

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

protectedinherited

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().

◆ offset_m

template<typename Field>

T ippl::ExtrapolateFace< Field >::offset_m

protectedinherited

Definition at line 115 of file BcTypes.h.

Referenced by apply(), ExtrapolateFace(), getOffset(), and ippl::ConstantFace< Field >::write().

◆ slope_m

template<typename Field>

T ippl::ExtrapolateFace< Field >::slope_m

protectedinherited

Definition at line 116 of file BcTypes.h.

Referenced by apply(), ExtrapolateFace(), and getSlope().

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