DAOption Class Reference

Inheritance diagram for DAOption:

Collaboration diagram for DAOption:

Public Member Functions
	DAOption (const fvMesh &mesh, PyObject *pyOptions)
	Constructors. More...
virtual	~DAOption ()
	Destructor. More...
const dictionary &	getAllOptions () const
	return a reference of allOptions_ dictionary More...
template<class classType >
classType	getOption (const word key) const
	get an option from subDict and key More...
template<class classType >
void	setOption (const word key, const classType value)
	set an option to subDict and key More...
template<class classType >
classType	getSubDictOption (const word subDict, const word subDictKey) const
	get an dictionary option from subDict and key More...
template<class classType >
void	setSubDictOption (const word subDict, const word subDictKey, const classType value)
	set an dictionary option to subDict and key More...
bool	writeData (Ostream &os) const
	this is a virtual function for regIOobject More...
void	updateDAOption (PyObject *pyOptions)
	update the allOptions_ dict in DAOption based on the pyOptions from pyDAFoam More...

Detailed Description

Definition at line 29 of file DAOption.H.

Constructor & Destructor Documentation

DAOption()

DAOption	(	const fvMesh &	mesh,
		PyObject *	pyOptions
	)

Constructors.

Definition at line 16 of file DAOption.C.

References DAUtility::pyDict2OFDict().

Here is the call graph for this function:

~DAOption()

~DAOption ( )

virtual

Destructor.

Definition at line 46 of file DAOption.C.

Member Function Documentation

getAllOptions()

const dictionary& getAllOptions ( ) const

inline

return a reference of allOptions_ dictionary

Definition at line 56 of file DAOption.H.

Referenced by DAFvSourceUniformPressureGradient::calcFvSource(), DAFvSourceActuatorLine::calcFvSource(), DAFvSourceActuatorPoint::calcFvSource(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAPartDerivdRdACTD::calcPartDerivMat(), DAPartDerivdRdACTL::calcPartDerivMat(), DAPartDerivdRdACTP::calcPartDerivMat(), DAPartDerivdFdACTD::calcPartDerivMat(), DAJacCon::checkSpecialBCs(), DAMotionTranslation::DAMotionTranslation(), DAMotionTranslationCoupled::DAMotionTranslationCoupled(), DAObjFuncForce::DAObjFuncForce(), DAJacCon::initializeStateBoundaryCon(), DAField::setPrimalBoundaryConditions(), DAJacCondRdW::setupdRdWCon(), DAJacCondFdW::setupJacCon(), and DAFvSource::syncDAOptionToActuatorDVs().

Here is the caller graph for this function:

getOption()

classType getOption

(

const word

key

)

const

get an option from subDict and key

Definition at line 92 of file DAOption.H.

Referenced by DAJacCon::calcColoredColumns(), PYDAFOAM::calcdFdAOAAnalytical(), PYDAFOAM::calcFFD2XvSeedVec(), DAFvSourceActuatorLine::calcFvSource(), DAFvSourceActuatorPoint::calcFvSource(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAJacCon::calcJacConColoring(), DAPartDerivdFdFFD::calcPartDerivMat(), DAPartDerivdRdFFD::calcPartDerivMat(), DAPartDerivdRdW::calcPartDerivMat(), DAPartDerivdFdAOA::calcPartDerivMat(), DAPartDerivdFdBC::calcPartDerivMat(), DAPartDerivdFdACTD::calcPartDerivMat(), DAPartDerivdFdW::calcPartDerivMat(), PYDAFOAM::calcPrimalResidualStatistics(), DAResidualRhoSimpleCFoam::calcResiduals(), DAResidualTurboFoam::calcResiduals(), DAIndex::calcStateLocalIndexOffset(), DAFvSourceActuatorDisk::DAFvSourceActuatorDisk(), DAObjFuncTotalPressureRatio::DAObjFuncTotalPressureRatio(), DAObjFuncTotalTemperatureRatio::DAObjFuncTotalTemperatureRatio(), DAResidualRhoSimpleCFoam::DAResidualRhoSimpleCFoam(), DAResidualRhoSimpleFoam::DAResidualRhoSimpleFoam(), DAResidualTurboFoam::DAResidualTurboFoam(), DAIndex::getLocalAdjointStateIndex(), DALinearEqn::getPrintInterval(), DAJacCondRdW::initializeJacCon(), DAJacCon::initializeStateBoundaryCon(), PYDAFOAM::initTimeInstanceMats(), PYDAFOAM::mapVector(), DAColoring::parallelD2Coloring(), PYDAFOAM::runColoring(), PYDAFOAM::setdXvdFFDMat(), PYDAFOAM::setEvalFuncs(), PYDAFOAM::setFieldValue4GlobalCellI(), PYDAFOAM::setFieldValue4LocalCellI(), PYDAFOAM::setPrimalBoundaryConditions(), PYDAFOAM::setStates(), PYDAFOAM::setTimeInstanceField(), PYDAFOAM::setTimeInstanceVar(), DAJacCondRdW::setupdRdWCon(), PYDAFOAM::solveAdjoint(), PYDAFOAM::solvePrimal(), PYDAFOAM::syncDAOptionToActuatorDVs(), PYDAFOAM::updateBoundaryConditions(), DAResidualSolidDisplacementFoam::updateDAndGradD(), PYDAFOAM::updateDAOption(), PYDAFOAM::vec2ArraySeq(), and PYDAFOAM::zeroTimeAccurateAdjointVectors().

setOption()

void setOption	(	const word	key,
		const classType	value
	)

set an option to subDict and key

Definition at line 127 of file DAOption.H.

Referenced by PYDAFOAM::solveAdjoint(), and PYDAFOAM::zeroTimeAccurateAdjointVectors().

Here is the caller graph for this function:

getSubDictOption()

classType getSubDictOption	(	const word	subDict,
		const word	subDictKey
	)		const

get an dictionary option from subDict and key

Definition at line 165 of file DAOption.H.

Referenced by DAPartDerivdFdFFD::calcPartDerivMat(), DAPartDerivdRdW::calcPartDerivMat(), DAPartDerivdRdAOA::calcPartDerivMat(), DAPartDerivdRdBC::calcPartDerivMat(), DAPartDerivdRdFFD::calcPartDerivMat(), DAPartDerivdFdBC::calcPartDerivMat(), DAPartDerivdFdAOA::calcPartDerivMat(), DAPartDerivdRdACTD::calcPartDerivMat(), DAPartDerivdFdACTD::calcPartDerivMat(), DAPartDerivdFdW::calcPartDerivMat(), DAPartDerivdRdACTL::calcPartDerivMat(), DAPartDerivdRdACTP::calcPartDerivMat(), DALinearEqn::createMLRKSP(), DACheckMesh::DACheckMesh(), and DALinearEqn::solveLinearEqn().

Here is the caller graph for this function:

setSubDictOption()

void setSubDictOption	(	const word	subDict,
		const word	subDictKey,
		const classType	value
	)

set an dictionary option to subDict and key

Definition at line 201 of file DAOption.H.

writeData()

bool writeData

(

Ostream &

os

)

const

this is a virtual function for regIOobject

Definition at line 66 of file DAOption.C.

updateDAOption()

void updateDAOption

(

PyObject *

pyOptions

)

update the allOptions_ dict in DAOption based on the pyOptions from pyDAFoam

Definition at line 50 of file DAOption.C.

References DAUtility::pyDict2OFDict().

Referenced by PYDAFOAM::solveAdjoint().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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