Contains all the global variables related to the imposing of initial conditions, and functions to impose them. More...
#include "lib/initial/initial.h"
Inheritance diagram for initial:
Public Member Functions | |
| initial (const grid &mesh) | |
| Constructor of the initial class. More... | |
| virtual void | initializeField (vfield &uField) |
| Prototype function to impose the initial conditions on the given field. More... | |
| virtual void | initializeField (vfield &uField, sfield &tField) |
| Prototype function to impose the initial conditions on the given field. More... | |
Protected Attributes | |
| const grid & | mesh |
Detailed Description
Contains all the global variables related to the imposing of initial conditions, and functions to impose them.
Constructor & Destructor Documentation
◆ initial()
| initial::initial | ( | const grid & | mesh | ) |
Constructor of the initial class.
The empty constructer merely initializes the local reference to the global mesh variable.
- Parameters
-
mesh is a const reference to the global data contained in the grid class
Member Function Documentation
◆ initializeField() [1/2]
|
virtual |
Prototype function to impose the initial conditions on the given field.
- Parameters
-
uField is a reference to the velocity vector field to be initialized
Reimplemented in taylorGreen, channelSine, channelRand, and zeroInitial.
◆ initializeField() [2/2]
Prototype function to impose the initial conditions on the given field.
- Parameters
-
uField is a reference to the velocity vector field to be initialized uField is a reference to the scalar field to be initialized
Reimplemented in zeroInitial.
The documentation for this class was generated from the following files:
- lib/initial/initial.h
- lib/initial/initial.cc
