METHOD
ParallelFlow Class Reference

#include <parallelBoundaryConds.h>

Inheritance diagram for ParallelFlow:
Collaboration diagram for ParallelFlow:

Public Member Functions

 ParallelFlow (Data *data, ParallelEnv *env)
 
virtual ~ParallelFlow ()
 
void apply (double *cons, double *prims=NULL, double *aux=NULL)
 
void setYBoundary (double *stateVector, int nVars)
 
void setZBoundary (double *stateVector, int nVars)
 
- Public Member Functions inherited from ParallelBcs
 ParallelBcs (Data *data, ParallelEnv *env)
 
virtual ~ParallelBcs ()
 
void swapGhostBuffers (double *sendToLeftBuf, double *sendToRightBuf, double *recvFromLeftBuf, double *recvFromRightBuf, int leftNeighbour, int rightNeighbour, int numCellsSent)
 
void packXBuffer (double *sendToLeftBuf, double *sendToRightBuf, double *stateVector, int nVars)
 
void unpackXBuffer (double *recvFromLeftBuf, double *recfFromRightBuf, double *stateVector, int nVars)
 
void packYBuffer (double *sendToLeftBuf, double *sendToRightBuf, double *stateVector, int nVars)
 
void unpackYBuffer (double *recvFromLeftBuf, double *recfFromRightBuf, double *stateVector, int nVars)
 
void packZBuffer (double *sendToLeftBuf, double *sendToRightBuf, double *stateVector, int nVars)
 
void unpackZBuffer (double *recvFromLeftBuf, double *recfFromRightBuf, double *stateVector, int nVars)
 

Additional Inherited Members

- Public Attributes inherited from ParallelBcs
ParallelEnvenv
 
- Protected Member Functions inherited from Bcs
 Bcs (Data *data)
 
virtual ~Bcs ()
 
- Protected Attributes inherited from Bcs
Datadata
 

Detailed Description

Flow boundary conditions for a data structure that has been distributed across ranks

Boundary conditions used for the Kelvin Helmholtz instability. The x-direction is periodic and y- and z-directions are outflow.

Definition at line 265 of file parallelBoundaryConds.h.

Constructor & Destructor Documentation

◆ ParallelFlow()

ParallelFlow::ParallelFlow ( Data data,
ParallelEnv env 
)
inline

Constructor.

Calls constructor of base class to store the pointer to the Data class and ParallelEnv class.

Parameters
[in]*datapointer to Data class
[in]*envpointer to ParallelEnv class
See also
ParallelBcs::ParallelBcs

Definition at line 275 of file parallelBoundaryConds.h.

◆ ~ParallelFlow()

virtual ParallelFlow::~ParallelFlow ( )
inlinevirtual

Destructor.

Definition at line 277 of file parallelBoundaryConds.h.

Member Function Documentation

◆ apply()

void ParallelFlow::apply ( double *  cons,
double *  prims = NULL,
double *  aux = NULL 
)
virtual

Application function.

Applies the Flow boundary conditions to the ghost cells.

Parameters
[in,out]*conspointer to the conservative (sized) vector
[in,out]*primsoptional pointer to the primitive vector
[in,out]*auxoptional pointer to the primitive vector
See also
Bcs::apply

Implements Bcs.

◆ setYBoundary()

void ParallelFlow::setYBoundary ( double *  stateVector,
int  nVars 
)

Applies the Flow boundary conditions to the ghost cells of subdomains that have an external face along the y dimension.

Parameters
[in,out]*stateVectorpointer to one of cons, prims, aux
[in]nVarsnumber of variables in the cons, prims or aux array

◆ setZBoundary()

void ParallelFlow::setZBoundary ( double *  stateVector,
int  nVars 
)

Applies the Flow boundary conditions to the ghost cells of subdomains that have an external face along the z dimension.

Parameters
[in,out]*stateVectorpointer to one of cons, prims, aux
[in]nVarsnumber of variables in the cons, prims or aux array

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