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...
void	setActuatorDVs (const word diskName, const label dvI, const scalar val)
	set a new value to the actuator disk design variable More...
scalar	getActuatorDVs (const word diskName, const label dvI)
	get the value from the actuator disk design variable More...
void	updateFvSource ()
	calculate fvSource based on the latest actuatorDVs More...
void	syncDAOptionToActuatorDVs ()
	synchronize the values in DAOption and actuatorDiskDVs_ More...
bool	writeData (Ostream &os) const
	virtual function for regIOobject More...

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...
HashTable< List< scalar > >	actuatorDiskDVs_
	the list of design variables for all the actuator disks 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 101 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 daIndex(), daModel(), daOption(), and mesh.

Referenced by DAPimpleFoam::initSolver(), DAPisoFoam::initSolver(), DARhoSimpleFoam::initSolver(), DASimpleTFoam::initSolver(), and DASimpleFoam::initSolver().

Here is the call graph for this function:

Here is the caller graph for this function:

calcFvSource()

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 DAResidualPimpleFoam::calcResiduals(), DAResidualPisoFoam::calcResiduals(), DAResidualSimpleFoam::calcResiduals(), DAResidualSimpleTFoam::calcResiduals(), DAResidualRhoSimpleFoam::calcResiduals(), and DAFvSource::updateFvSource().

Here is the caller graph for this function:

setActuatorDVs()

void setActuatorDVs ( const word  diskName, const label  dvI, const scalar  val  )

inline

set a new value to the actuator disk design variable

Definition at line 109 of file DAFvSource.H.

References DAFvSource::actuatorDiskDVs_.

getActuatorDVs()

scalar getActuatorDVs ( const word  diskName, const label  dvI  )

inline

get the value from the actuator disk design variable

Definition at line 118 of file DAFvSource.H.

References DAFvSource::actuatorDiskDVs_.

updateFvSource()

void updateFvSource ( )

inline

calculate fvSource based on the latest actuatorDVs

Definition at line 126 of file DAFvSource.H.

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

Here is the call graph for this function:

syncDAOptionToActuatorDVs()

void syncDAOptionToActuatorDVs

(

)

synchronize the values in DAOption and actuatorDiskDVs_

Definition at line 113 of file DAFvSource.C.

References DAFvSource::actuatorDiskDVs_, DAFvSource::daOption_, forAll(), and DAOption::getAllOptions().

Referenced by DAFvSourceActuatorDisk::DAFvSourceActuatorDisk(), and PYDAFOAM::updateDAOption().

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 103 of file DAFvSource.C.

Member Data Documentation

modelType_

const word& modelType_

protected

model name

Definition at line 47 of file DAFvSource.H.

Referenced by DAFvSource::calcFvSource().

mesh_

const fvMesh& mesh_

protected

fvMesh

Definition at line 50 of file DAFvSource.H.

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

daOption_

const DAOption& daOption_

protected

DAOption object.

Definition at line 53 of file DAFvSource.H.

Referenced by DAFvSourceUniformPressureGradient::calcFvSource(), DAFvSourceActuatorPoint::calcFvSource(), DAFvSourceActuatorLine::calcFvSource(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), and DAFvSource::syncDAOptionToActuatorDVs().

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.

actuatorDiskDVs_

HashTable<List<scalar> > actuatorDiskDVs_

protected

the list of design variables for all the actuator disks

Definition at line 62 of file DAFvSource.H.

Referenced by DAFvSourceActuatorDisk::calcFvSource(), DAFvSource::getActuatorDVs(), DAFvSource::setActuatorDVs(), and DAFvSource::syncDAOptionToActuatorDVs().

---

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

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