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().
◆ ~DAOption()
|
virtual |
Destructor.
Definition at line 46 of file DAOption.C.
Member Function Documentation
◆ getAllOptions()
|
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(), DAFvSourceHeatSource::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAResidualPimpleDyMFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAJacCon::checkSpecialBCs(), DAFunction::DAFunction(), DAFunctionForce::DAFunctionForce(), DAFunctionResidualNorm::DAFunctionResidualNorm(), DAFunctionWallHeatFlux::DAFunctionWallHeatFlux(), DAFvSourceHeatSource::DAFvSourceHeatSource(), DAInputField::DAInputField(), DAInputFieldUnsteady::DAInputFieldUnsteady(), DAInputFvSourcePar::DAInputFvSourcePar(), DAInputPatchVar::DAInputPatchVar(), DAInputThermalCoupling::DAInputThermalCoupling(), DAOutputForceCoupling::DAOutputForceCoupling(), DAOutputThermalCoupling::DAOutputThermalCoupling(), DARegression::DARegression(), DAResidualHeatTransferFoam::DAResidualHeatTransferFoam(), DAResidualPimpleDyMFoam::DAResidualPimpleDyMFoam(), DAResidualPimpleFoam::DAResidualPimpleFoam(), DAResidualRhoPimpleFoam::DAResidualRhoPimpleFoam(), DAResidualRhoSimpleFoam::DAResidualRhoSimpleFoam(), DAResidualSimpleFoam::DAResidualSimpleFoam(), DAInputFieldUnsteady::distributed(), DAInputField::distributed(), DAFvSourceActuatorLine::initFvSourcePars(), DAFvSourceActuatorPoint::initFvSourcePars(), DAFvSourceActuatorDisk::initFvSourcePars(), DAFvSourceHeatSource::initFvSourcePars(), DAJacCon::initializeStateBoundaryCon(), DARadiationModel::New(), DAStateInfo::New(), DAFvSource::New(), DAResidual::New(), DAInput::New(), DAOutput::New(), DAFunction::New(), DATurbulenceModel::New(), DAField::point2OFMesh(), DAInputVolCoord::run(), DAInputPatchVelocity::run(), DAInputPatchVar::run(), DAField::setPrimalBoundaryConditions(), and DAJacCon::setupdRdWCon().
◆ getOption()
| classType getOption | ( | const word | key | ) | const |
get an option from subDict and key
Definition at line 92 of file DAOption.H.
Referenced by PYDAFOAM::__call__(), PYDAFOAM::array2Vec(), DAJacCon::calcColoredColumns(), PYDAFOAM::calcFFD2XvSeeds(), DAFvSourceActuatorDisk::calcFvSource(), DAFvSourceActuatorDisk::calcFvSourceCellIndices(), DAJacCon::calcJacConColoring(), DAPartDeriv::calcPartDerivMat(), DAResidualPimpleDyMFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), PYDAFOAM::calcPrimalResidualStatistics(), DAResidualPimpleDyMFoam::calcResiduals(), DAResidualPimpleFoam::calcResiduals(), DAResidualSimpleFoam::calcResiduals(), DAResidualRhoSimpleCFoam::calcResiduals(), DAResidualTurboFoam::calcResiduals(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoSimpleFoam::calcResiduals(), DAIndex::calcStateLocalIndexOffset(), DAField::DAField(), DAFunctionMeshQualityKS::DAFunctionMeshQualityKS(), DAFunctionResidualNorm::DAFunctionResidualNorm(), DAFunctionTotalPressureRatio::DAFunctionTotalPressureRatio(), DAFunctionTotalTemperatureRatio::DAFunctionTotalTemperatureRatio(), DAFvSourceActuatorDisk::DAFvSourceActuatorDisk(), DAFvSourceActuatorLine::DAFvSourceActuatorLine(), DAFvSourceActuatorPoint::DAFvSourceActuatorPoint(), DAFvSourceHeatSource::DAFvSourceHeatSource(), DAInput::DAInput(), DAJacCon::DAJacCon(), DAOutput::DAOutput(), DAPartDeriv::DAPartDeriv(), DAResidualRhoPimpleFoam::DAResidualRhoPimpleFoam(), DAResidualRhoSimpleCFoam::DAResidualRhoSimpleCFoam(), DAResidualRhoSimpleFoam::DAResidualRhoSimpleFoam(), DAResidualTurboFoam::DAResidualTurboFoam(), PYDAFOAM::deformDynamicMesh(), PYDAFOAM::evalFunctions(), DAIndex::getLocalAdjointStateIndex(), DALinearEqn::getPrintInterval(), DAJacCon::initializeJacCon(), DAJacCon::initializeStateBoundaryCon(), DAColoring::parallelD2Coloring(), PYDAFOAM::runDecomposePar(), PYDAFOAM::set_solver_input(), DAJacCon::setupdRdWCon(), PYDAFOAM::updateDAOption(), and PYDAFOAM::writeAdjointFields().
◆ 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::__call__().
◆ 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 DAPartDeriv::calcPartDerivMat(), DALinearEqn::createMLRKSP(), DACheckMesh::DACheckMesh(), and DALinearEqn::solveLinearEqn().
◆ 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::__call__().
The documentation for this class was generated from the following files:
- dafoam/src/adjoint/DAOption/DAOption.H
- dafoam/src/adjoint/DAOption/DAOption.C
