DAFvSource Class Reference

Inheritance diagram for DAFvSource:

Collaboration diagram for DAFvSource:

Public Member Functions
	TypeName ("DAFvSource")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, DAFvSource, dictionary,(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex),(modelType, mesh, daOption, daModel, daIndex))
	DAFvSource (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAFvSource ()
virtual void	calcFvSource (volVectorField &fvSource)
	compute the FvSource term More...
virtual void	calcFvSource (volScalarField &fvSource)
	overloaded function for scalar fields More...
virtual void	initFvSourcePars ()
	Initialize the values for all types of fvSource in DAGlobalVar, including actuatorDiskPars, heatSourcePars, etc. More...
void	updateFvSource ()
	calculate fvSource based on the latest parameters defined in DAGlobalVar More...
bool	writeData (Ostream &os) const
	virtual function for regIOobject More...
void	findGlobalSnappedCenter (label snappedCenterCellI, vector &center)

Static Public Member Functions
static autoPtr< DAFvSource >	New (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)

Protected Attributes
const word &	modelType_
	model name More...
const fvMesh &	mesh_
	fvMesh More...
const DAOption &	daOption_
	DAOption object. More...
const DAModel &	daModel_
	DAModel object. More...
const DAIndex &	daIndex_
	DAIndex object. More...

Detailed Description

Definition at line 34 of file DAFvSource.H.

Constructor & Destructor Documentation

DAFvSource()

DAFvSource	(	const word	modelType,
		const fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex
	)

Definition at line 22 of file DAFvSource.C.

~DAFvSource()

virtual ~DAFvSource ( )

inlinevirtual

Definition at line 98 of file DAFvSource.H.

Member Function Documentation

TypeName()

TypeName

(

"DAFvSource"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		DAFvSource	,
		dictionary	,
		(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)	,
		(modelType, mesh, daOption, daModel, daIndex)
	)

New()

autoPtr< DAFvSource > New ( const word  modelType, const fvMesh &  mesh, const DAOption &  daOption, const DAModel &  daModel, const DAIndex &  daIndex  )

static

Definition at line 47 of file DAFvSource.C.

References DAOption::getAllOptions(), and mesh.

Referenced by DAHeatTransferFoam::initSolver(), DARhoPimpleFoam::initSolver(), DARhoSimpleFoam::initSolver(), DAPimpleFoam::initSolver(), DAPimpleDyMFoam::initSolver(), and DASimpleFoam::initSolver().

Here is the call graph for this function:

Here is the caller graph for this function:

calcFvSource() [1/2]

void calcFvSource ( volVectorField &  fvSource )

virtual

compute the FvSource term

Reimplemented in DAFvSourceActuatorDisk, DAFvSourceActuatorLine, DAFvSourceActuatorPoint, and DAFvSourceUniformPressureGradient.

Definition at line 90 of file DAFvSource.C.

References DAFvSource::modelType_.

Referenced by DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualHeatTransferFoam::calcResiduals(), DAResidualPimpleFoam::calcResiduals(), DAResidualPimpleDyMFoam::calcResiduals(), DAResidualSimpleFoam::calcResiduals(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoSimpleFoam::calcResiduals(), and DAFvSource::updateFvSource().

Here is the caller graph for this function:

calcFvSource() [2/2]

void calcFvSource ( volScalarField &  fvSource )

virtual

overloaded function for scalar fields

Reimplemented in DAFvSourceHeatSource.

Definition at line 103 of file DAFvSource.C.

References DAFvSource::modelType_.

initFvSourcePars()

void initFvSourcePars ( )

virtual

Initialize the values for all types of fvSource in DAGlobalVar, including actuatorDiskPars, heatSourcePars, etc.

Reimplemented in DAFvSourceHeatSource, DAFvSourceActuatorDisk, DAFvSourceActuatorLine, and DAFvSourceActuatorPoint.

Definition at line 126 of file DAFvSource.C.

References DAFvSource::modelType_.

updateFvSource()

void updateFvSource

(

)

calculate fvSource based on the latest parameters defined in DAGlobalVar

Definition at line 163 of file DAFvSource.C.

References DAFvSource::calcFvSource(), fvSource, and DAFvSource::mesh_.

Referenced by DAInputFvSourcePar::run().

Here is the call graph for this function:

Here is the caller graph for this function:

writeData()

bool writeData

(

Ostream &

os

)

const

virtual function for regIOobject

Definition at line 116 of file DAFvSource.C.

findGlobalSnappedCenter()

void findGlobalSnappedCenter	(	label	snappedCenterCellI,
		vector &	center
	)

Definition at line 140 of file DAFvSource.C.

References DAFvSource::mesh_.

Referenced by DAFvSourceHeatSource::calcFvSource(), and DAFvSourceHeatSource::DAFvSourceHeatSource().

Here is the caller graph for this function:

Member Data Documentation

modelType_

const word& modelType_

protected

model name

Definition at line 47 of file DAFvSource.H.

Referenced by DAFvSource::calcFvSource(), and DAFvSource::initFvSourcePars().

mesh_

const fvMesh& mesh_

protected

fvMesh

Definition at line 50 of file DAFvSource.H.

Referenced by DAFvSourceActuatorLine::calcFvSource(), DAFvSourceActuatorPoint::calcFvSource(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceHeatSource::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAFvSourceHeatSource::DAFvSourceHeatSource(), DAFvSource::findGlobalSnappedCenter(), DAFvSourceActuatorPoint::initFvSourcePars(), DAFvSourceActuatorLine::initFvSourcePars(), DAFvSourceActuatorDisk::initFvSourcePars(), DAFvSourceHeatSource::initFvSourcePars(), and DAFvSource::updateFvSource().

daOption_

const DAOption& daOption_

protected

DAOption object.

Definition at line 53 of file DAFvSource.H.

Referenced by DAFvSourceUniformPressureGradient::calcFvSource(), DAFvSourceActuatorLine::calcFvSource(), DAFvSourceActuatorPoint::calcFvSource(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceHeatSource::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAFvSourceHeatSource::DAFvSourceHeatSource(), DAFvSourceActuatorLine::initFvSourcePars(), DAFvSourceActuatorPoint::initFvSourcePars(), DAFvSourceActuatorDisk::initFvSourcePars(), and DAFvSourceHeatSource::initFvSourcePars().

daModel_

const DAModel& daModel_

protected

DAModel object.

Definition at line 56 of file DAFvSource.H.

daIndex_

const DAIndex& daIndex_

protected

DAIndex object.

Definition at line 59 of file DAFvSource.H.

---

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

• dafoam/src/adjoint/DAFvSource/DAFvSource.H
• dafoam/src/adjoint/DAFvSource/DAFvSource.C