PlasCom2  1.0
XPACC Multi-physics simluation application
Public Types | Public Member Functions | Protected Attributes | List of all members
base Class Reference

Detailed Description

Definition at line 85 of file Boundary.H.

#include <Boundary.H>

Public Types

typedef simulation::state::base StateType
 
typedef simulation::grid::parallel_blockstructured GridType
 
typedef simulation::domain::boundary::bc::base BCType
 

Public Member Functions

 base ()
 
void SetBC (BCType &inBC)
 
void SetState (StateType &inState)
 
void SetParams (StateType &inParams)
 
void DestroyState ()
 
void DestroyParams ()
 
void DestroyBC ()
 
void Destroy ()
 
void Create ()
 
StateType & State ()
 
const StateType & State () const
 
StateType & Params ()
 
const StateType & Params () const
 
GridType & Grid ()
 
const GridType & Grid () const
 
void SetGrid (GridType &inGrid)
 
BCType & BC ()
 
const BCType & BC () const
 
int GridRegionID () const
 
void SetGridRegionID (int inID)
 
const std::vector< pcpp::IndexIntervalType > & ThreadPartitionIntervals () const
 
std::vector< pcpp::IndexIntervalType > & ThreadPartitionIntervals ()
 
const std::vector< pcpp::IndexIntervalType > & ThreadBufferIntervals () const
 
std::vector< pcpp::IndexIntervalType > & ThreadBufferIntervals ()
 
const pcpp::IndexIntervalType & BoundaryPartitionInterval () const
 
pcpp::IndexIntervalType & BoundaryPartitionInterval ()
 
const pcpp::IndexIntervalType & PartitionBufferInterval () const
 
pcpp::IndexIntervalType & PartitionBufferInterval ()
 
void SetName (const std::string &inName)
 
const std::string & Name () const
 

Protected Attributes

int gridRegionID
 
BCType * bcPtr
 
StateType * statePtr
 
StateType * paramPtr
 
GridType * gridPtr
 
std::string boundaryName
 
pcpp::IndexIntervalType boundaryPartitionInterval
 
pcpp::IndexIntervalType partitionBufferInterval
 
std::vector< pcpp::IndexIntervalType > threadPartitionIntervals
 
std::vector< pcpp::IndexIntervalType > threadBufferIntervals
 
bool myState
 
bool myParams
 
bool myBC
 
Collaboration diagram for base:
[legend]

Member Typedef Documentation

◆ BCType

typedef simulation::domain::boundary::bc::base BCType

Definition at line 91 of file Boundary.H.

◆ GridType

typedef simulation::grid::parallel_blockstructured GridType

Definition at line 90 of file Boundary.H.

◆ StateType

typedef simulation::state::base StateType

Definition at line 89 of file Boundary.H.

Constructor & Destructor Documentation

◆ base()

base ( )
inline

Definition at line 93 of file Boundary.H.

References base::Create().

Here is the call graph for this function:

Member Function Documentation

◆ BC() [1/2]

BCType& BC ( )
inline

Definition at line 169 of file Boundary.H.

Referenced by rhs< GridT, StateT, OperatorT >::HandleBoundaryConditions(), and rhs< GridT, StateT, OperatorT >::SetDomainBCs().

Here is the caller graph for this function:

◆ BC() [2/2]

const BCType& BC ( ) const
inline

Definition at line 170 of file Boundary.H.

◆ BoundaryPartitionInterval() [1/2]

const pcpp::IndexIntervalType& BoundaryPartitionInterval ( ) const
inline

Definition at line 183 of file Boundary.H.

◆ BoundaryPartitionInterval() [2/2]

pcpp::IndexIntervalType& BoundaryPartitionInterval ( )
inline

Definition at line 185 of file Boundary.H.

◆ Create()

void Create ( )
inline

Definition at line 148 of file Boundary.H.

References base::BCType(), base::Destroy(), base::myParams, and base::paramPtr.

Here is the call graph for this function:

◆ Destroy()

void Destroy ( )
inline

Definition at line 141 of file Boundary.H.

References base::DestroyParams().

Here is the call graph for this function:

◆ DestroyBC()

void DestroyBC ( )
inline

Definition at line 133 of file Boundary.H.

◆ DestroyParams()

void DestroyParams ( )
inline

Definition at line 125 of file Boundary.H.

References base::myParams, and base::paramPtr.

◆ DestroyState()

void DestroyState ( )
inline

Definition at line 117 of file Boundary.H.

◆ Grid() [1/2]

GridType& Grid ( )
inline

Definition at line 165 of file Boundary.H.

◆ Grid() [2/2]

const GridType& Grid ( ) const
inline

Definition at line 166 of file Boundary.H.

◆ GridRegionID()

int GridRegionID ( ) const
inline

Definition at line 172 of file Boundary.H.

Referenced by rhs< GridT, StateT, OperatorT >::HandleBoundaryConditions(), rhs< GridT, StateT, OperatorT >::SetDomainBCs(), and rhs< GridT, StateT, OperatorT >::SetDomainBoundaries().

Here is the caller graph for this function:

◆ Name()

const std::string& Name ( ) const
inline

Definition at line 193 of file Boundary.H.

Referenced by rhs< GridT, StateT, OperatorT >::HandleBoundaryConditions().

Here is the caller graph for this function:

◆ Params() [1/2]

StateType& Params ( )
inline

Definition at line 162 of file Boundary.H.

References base::paramPtr.

◆ Params() [2/2]

const StateType& Params ( ) const
inline

Definition at line 163 of file Boundary.H.

References base::paramPtr.

◆ PartitionBufferInterval() [1/2]

const pcpp::IndexIntervalType& PartitionBufferInterval ( ) const
inline

Definition at line 187 of file Boundary.H.

◆ PartitionBufferInterval() [2/2]

pcpp::IndexIntervalType& PartitionBufferInterval ( )
inline

Definition at line 189 of file Boundary.H.

◆ SetBC()

void SetBC ( BCType &  inBC)
inline

Definition at line 99 of file Boundary.H.

Referenced by base< GridT, StateT >::ConfigureGridDomainBoundaries().

Here is the caller graph for this function:

◆ SetGrid()

void SetGrid ( GridType &  inGrid)
inline

Definition at line 167 of file Boundary.H.

Referenced by base< GridT, StateT >::ConfigureGridDomainBoundaries().

Here is the caller graph for this function:

◆ SetGridRegionID()

void SetGridRegionID ( int  inID)
inline

Definition at line 173 of file Boundary.H.

Referenced by base< GridT, StateT >::ConfigureGridDomainBoundaries().

Here is the caller graph for this function:

◆ SetName()

void SetName ( const std::string &  inName)
inline

Definition at line 192 of file Boundary.H.

Referenced by base< GridT, StateT >::ConfigureGridDomainBoundaries().

Here is the caller graph for this function:

◆ SetParams()

void SetParams ( StateType &  inParams)
inline

Definition at line 111 of file Boundary.H.

References base::DestroyParams(), and base::paramPtr.

Here is the call graph for this function:

◆ SetState()

void SetState ( StateType &  inState)
inline

Definition at line 105 of file Boundary.H.

◆ State() [1/2]

StateType& State ( )
inline

Definition at line 160 of file Boundary.H.

◆ State() [2/2]

const StateType& State ( ) const
inline

Definition at line 161 of file Boundary.H.

◆ ThreadBufferIntervals() [1/2]

const std::vector<pcpp::IndexIntervalType>& ThreadBufferIntervals ( ) const
inline

Definition at line 179 of file Boundary.H.

◆ ThreadBufferIntervals() [2/2]

std::vector<pcpp::IndexIntervalType>& ThreadBufferIntervals ( )
inline

Definition at line 181 of file Boundary.H.

◆ ThreadPartitionIntervals() [1/2]

const std::vector<pcpp::IndexIntervalType>& ThreadPartitionIntervals ( ) const
inline

Definition at line 175 of file Boundary.H.

◆ ThreadPartitionIntervals() [2/2]

std::vector<pcpp::IndexIntervalType>& ThreadPartitionIntervals ( )
inline

Definition at line 177 of file Boundary.H.

Member Data Documentation

◆ bcPtr

BCType* bcPtr
protected

Definition at line 198 of file Boundary.H.

◆ boundaryName

std::string boundaryName
protected

Definition at line 202 of file Boundary.H.

◆ boundaryPartitionInterval

pcpp::IndexIntervalType boundaryPartitionInterval
protected

Definition at line 204 of file Boundary.H.

◆ gridPtr

GridType* gridPtr
protected

Definition at line 201 of file Boundary.H.

◆ gridRegionID

int gridRegionID
protected

Definition at line 193 of file Boundary.H.

◆ myBC

bool myBC
protected

Definition at line 214 of file Boundary.H.

◆ myParams

bool myParams
protected

Definition at line 213 of file Boundary.H.

◆ myState

bool myState
protected

Definition at line 212 of file Boundary.H.

◆ paramPtr

StateType* paramPtr
protected

Definition at line 200 of file Boundary.H.

◆ partitionBufferInterval

pcpp::IndexIntervalType partitionBufferInterval
protected

Definition at line 205 of file Boundary.H.

◆ statePtr

StateType* statePtr
protected

Definition at line 199 of file Boundary.H.

◆ threadBufferIntervals

std::vector<pcpp::IndexIntervalType> threadBufferIntervals
protected

Definition at line 207 of file Boundary.H.

◆ threadPartitionIntervals

std::vector<pcpp::IndexIntervalType> threadPartitionIntervals
protected

Definition at line 206 of file Boundary.H.

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