METHOD
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Bcs Class Referenceabstract

#include <boundaryConds.h>

Inheritance diagram for Bcs:
Inheritance graph
[legend]
Collaboration diagram for Bcs:
Collaboration graph
[legend]

Public Member Functions

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

Protected Member Functions

 Bcs (Data *data)
 
virtual ~Bcs ()
 

Protected Attributes

Data * data
 

Detailed Description

Boundary Conditions

Abstract base class for implementations of different boundary conditions. The fields to which the boundary conditions are applied are those passed into the function apply, not those in the SimData class.

Definition at line 13 of file boundaryConds.h.

Constructor & Destructor Documentation

◆ Bcs()

Bcs::Bcs ( Data *  data)
inlineprotected

Constructor store data about simulation (needed for domain)

Constructor simply stores the pointer to the Data class.

Parameters
[in]*datapointer to the Data class

Definition at line 25 of file boundaryConds.h.

◆ ~Bcs()

virtual Bcs::~Bcs ( )
inlineprotectedvirtual

Destructor.

Definition at line 30 of file boundaryConds.h.

Member Function Documentation

◆ apply()

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

Application function.

Pure virtual function definition of the apply function. Function will apply the specified boundary condition to the given vectors. Most often the convervative vector, or a vector of the same size (e.g. source/flux vector), will be the intended vector to apply boundary conditions too. Primitive and auxiliary variables can also be applied to.

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

Implemented in ParallelFlow, ParallelPeriodic, Flow, ParallelOutflow, Periodic, OutflowRotatedBW, and Outflow.

Member Data Documentation

◆ data

Data* Bcs::data
protected

Pointer to Data class containing global simulation data.

Definition at line 17 of file boundaryConds.h.

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