periodicCC Class Reference

The derived class from boundary to apply periodic boundary condition for a cell-centered variable. More...

#include "lib/boundary/boundary.h"

Inheritance diagram for periodicCC:

Public Member Functions
	periodicCC (const grid &mesh, field &inField, const int bcWall)
	Constructor of the periodicCC class. More...
void	imposeBC ()
	Function to impose periodic BC on a cell centered variable. More...
Public Member Functions inherited from boundary
	boundary (const grid &mesh, field &inField, const int bcWall)
	Constructor of the boundary class. More...

Additional Inherited Members
Protected Attributes inherited from boundary
const grid &	mesh
	A const reference to the global variables stored in the grid class to access mesh data.
field &	dField
	Reference to the field onto which the boundary condition has to be applied.
bool	rankFlag
	The flag is true for MPI ranks on which the boundary condition has to be applied.
const int	wallNum
	The const integer denotes the wall at which the boundary condition is being applied.
int	shiftDim
	Denotes the dimension normal to the wall at which the boundary condition is applied.
int	shiftVal
	The number of points by which the view of the wall slice is shifted to when applying the boundary condition.

Detailed Description

The derived class from boundary to apply periodic boundary condition for a cell-centered variable.

Constructor & Destructor Documentation

periodicCC()

periodicCC::periodicCC	(	const grid &	mesh,
		field &	inField,
		const int	bcWall
	)

Constructor of the periodicCC class.

     The constructor simply initializes the base boundary class using all the arguments supplied to it.
     Since periodic BC is being implemented, no additional values are necessary for the object.

Parameters

mesh	is a const reference to the global data contained in the grid class
inField	is a reference to the field to which the boundary conditions must be applied.
bcWall	is a const integer which specifies the wall to which the BC must be applied.

Member Function Documentation

imposeBC()

void periodicCC::imposeBC ( )

inlinevirtual

Function to impose periodic BC on a cell centered variable.

     For Saras solver, the wall passes through the cell centers of the variables.
     Hence the variable is lying on the wall for this case.
     This BC is used mainly in the Z-direction, because Saras supports pencil/slab decomposition only.
     Along Z, no MPI structures exist at all.
     Hence no MPI data transfer takes place, and this BC imposes periodic BC along Z.

Reimplemented from boundary.

---

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

• lib/boundary/boundary.h
• lib/boundary/periodicCC.cc