force Class Reference

Contains all the global variables related to the imposing of forcing, and associated functions. More...

#include "lib/force/force.h"

Inheritance diagram for force:

Public Member Functions
	force (const grid &mesh, vfield &U)
	Constructor of the force class. More...
virtual void	addForcing (plainvf &Hv)
	Prototype function to add the forcing field to a plain vector field. More...
virtual void	addForcing (plainsf &Ht)
	Prototype function to add the forcing field to a plain scalar field. More...

Protected Attributes
const grid &	mesh
vfield &	V

Detailed Description

Contains all the global variables related to the imposing of forcing, and associated functions.

Constructor & Destructor Documentation

force()

force::force	(	const grid &	mesh,
		vfield &	U
	)

Constructor of the force class.

     The empty constructor merely initializes the local reference to the global mesh variable and vector field for velocity.
     The velocity vector field is used for its interpolation slices to be used in calculating forcing terms.

Parameters

mesh	is a const reference to the global data contained in the grid class
U	is a reference to the velocity vector field

Member Function Documentation

addForcing() [1/2]

void force::addForcing ( plainsf &  Ht )

virtual

Prototype function to add the forcing field to a plain scalar field.

     Based on the values of Fb, Fr, and other constants as applicable, the appropriate forcing field is calculated and
     added to the input plain field.

Parameters

Ht	is a reference to the plain scalar field to which the forcing term is to be added (RHS of the temperature equation)

Reimplemented in coriolisForce, buoyantForce, rotatingConv, randomForcing, constantPGrad, and zeroForcing.

addForcing() [2/2]

void force::addForcing ( plainvf &  Hv )

virtual

Prototype function to add the forcing field to a plain vector field.

     Based on the values of Fb, Fr, and other constants as applicable, the appropriate forcing field is calculated and
     added to the input plain field.

Parameters

Hv	is a reference to the plain vector field to which the forcing term is to be added (RHS of the NSE)

Reimplemented in coriolisForce, buoyantForce, rotatingConv, randomForcing, constantPGrad, and zeroForcing.

---

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

• lib/force/force.h
• lib/force/force.cc