OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
PeriodicFace< T, D, M, C > Class Template Referenceabstract

#include <BCond.h>

Inheritance diagram for PeriodicFace< T, D, M, C >:
Inheritance graph
Collaboration diagram for PeriodicFace< T, D, M, C >:
Collaboration graph

Public Types

typedef BCondBase< T, D, M, C > BCondBaseTDMC
 

Public Member Functions

 PeriodicFace (unsigned f, int i=BCondBaseTDMC::allComponents, int j=BCondBaseTDMC::allComponents)
 
virtual void apply (Field< T, D, M, C > &)
 
virtual BCondBase< T, D, M, C > * clone () const
 
virtual void write (std::ostream &out) const
 
virtual void apply (Field< T, D, UniformCartesian< D, double >, typename M::DefaultCentering > &)=0
 
int getComponent () const
 
unsigned int getFace () const
 
bool changesPhysicalCells () const
 

Public Attributes

int RefCount
 

Static Public Attributes

static int allComponents
 

Protected Attributes

int m_component
 
unsigned int m_face
 
bool m_changePhysical
 

Detailed Description

template<class T, unsigned D, class M = UniformCartesian<D,double>, class C = typename M::DefaultCentering>
class PeriodicFace< T, D, M, C >

Definition at line 239 of file BCond.h.

Member Typedef Documentation

◆ BCondBaseTDMC

template<class T , unsigned D, class M = UniformCartesian<D,double>, class C = typename M::DefaultCentering>
typedef BCondBase<T,D,M,C> PeriodicFace< T, D, M, C >::BCondBaseTDMC

Definition at line 246 of file BCond.h.

Constructor & Destructor Documentation

◆ PeriodicFace()

template<class T , unsigned D, class M , class C >
PeriodicFace< T, D, M, C >::PeriodicFace ( unsigned  f,
int  i = BCondBaseTDMC::allComponents,
int  j = BCondBaseTDMC::allComponents 
)

Definition at line 282 of file BCond.hpp.

Member Function Documentation

◆ apply() [1/2]

template<class T , unsigned D, class M , class C >
void PeriodicFace< T, D, M, C >::apply ( Field< T, D, M, C > &  A)
virtual

Reimplemented in ParallelPeriodicFace< T, D, M, C >.

Definition at line 474 of file BCond.hpp.

References PeriodicFaceBCApply().

Here is the call graph for this function:

◆ apply() [2/2]

virtual void BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::apply ( Field< T, D, UniformCartesian< D, double > , typename M::DefaultCentering > &  )
pure virtualinherited

◆ changesPhysicalCells()

bool BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::changesPhysicalCells ( ) const
inlineinherited

Definition at line 175 of file BCond.h.

◆ clone()

template<class T , unsigned D, class M = UniformCartesian<D,double>, class C = typename M::DefaultCentering>
virtual BCondBase< T, D, M, C > * PeriodicFace< T, D, M, C >::clone ( ) const
inlinevirtual

Implements BCondBase< T, D, UniformCartesian< D, double >, typename M::DefaultCentering >.

Reimplemented in ParallelPeriodicFace< T, D, M, C >.

Definition at line 256 of file BCond.h.

◆ getComponent()

int BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::getComponent ( ) const
inlineinherited

Definition at line 169 of file BCond.h.

◆ getFace()

unsigned int BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::getFace ( ) const
inlineinherited

Definition at line 172 of file BCond.h.

◆ write()

template<class T , unsigned int D, class M , class C >
void PeriodicFace< T, D, M, C >::write ( std::ostream &  out) const
virtual

Reimplemented from BCondBase< T, D, UniformCartesian< D, double >, typename M::DefaultCentering >.

Reimplemented in ParallelPeriodicFace< T, D, M, C >.

Definition at line 113 of file BCond.hpp.

Member Data Documentation

◆ allComponents

int BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::allComponents
staticinherited

Definition at line 152 of file BCond.h.

◆ m_changePhysical

bool BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::m_changePhysical
protectedinherited

Definition at line 187 of file BCond.h.

◆ m_component

int BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::m_component
protectedinherited

Definition at line 181 of file BCond.h.

◆ m_face

unsigned int BCondBase< T, D, UniformCartesian< D, double > , typename M::DefaultCentering >::m_face
protectedinherited

Definition at line 184 of file BCond.h.

◆ RefCount

int RefCounted::RefCount
inherited

Definition at line 21 of file RefCounted.h.

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