Public Member Functions | Protected Attributes | List of all members
DAObjFuncTotalPressureRatio Class Reference
Inheritance diagram for DAObjFuncTotalPressureRatio:
Inheritance graph
[legend]
Collaboration diagram for DAObjFuncTotalPressureRatio:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("totalPressureRatio")
 
 DAObjFuncTotalPressureRatio (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)
 
virtual ~DAObjFuncTotalPressureRatio ()
 
virtual void calcObjFunc (const labelList &objFuncFaceSources, const labelList &objFuncCellSources, scalarList &objFuncFaceValues, scalarList &objFuncCellValues, scalar &objFuncValue)
 calculate the value of objective function More...
 
- Public Member Functions inherited from DAObjFunc
 TypeName ("DAObjFunc")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DAObjFunc, dictionary,(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict),(mesh, daOption, daModel, daIndex, daResidual, objFuncName, objFuncPart, objFuncDict))
 
 DAObjFunc (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)
 
virtual ~DAObjFunc ()
 
void clear ()
 clear up members More...
 
void calcObjFuncSources (labelList &faceSources, labelList &cellSources)
 calculate DAObjFunc::objFuncFaceSources_ and DAObjFunc::objFuncCellSources_ More...
 
scalar getObjFuncValue ()
 calculate the value of objective function More...
 
scalar masterFunction (const dictionary &options, const Vec xvVec, const Vec wVec)
 the master function to compute objective function given the state and point vectors More...
 
word getObjFuncName ()
 return the name of objective function More...
 
word getObjFuncPart ()
 return the part of objective function More...
 
word getObjFuncType ()
 return the part of objective function More...
 
const labelList & getObjFuncFaceSources () const
 return DAObjFunc::objFuncFaceSources_ More...
 
const labelList & getObjFuncCellSources () const
 return DAObjFunc::objFuncCellSources_ More...
 
const scalarList & getObjFuncFaceValues () const
 return DAObjFunc::objFuncFaceValues_ More...
 
const scalarList & getObjFuncCellValues () const
 return DAObjFunc::objFuncCellValues_ More...
 
const List< List< word > > & getObjFuncConInfo () const
 return DAObjFunc::objFuncConInfo_ More...
 

Protected Attributes

scalar areaSumInlet_ = -9999.0
 the area of all inlet patches More...
 
scalar areaSumOutlet_ = -9999.0
 the area of all outlet patches More...
 
wordList outletPatches_
 names of outlet patches More...
 
wordList inletPatches_
 names of inlet patches More...
 
scalar TPInRef_ = 0.0
 
scalar TPOutRef_ = 0.0
 
scalar Cp_
 
scalar gamma_
 
- Protected Attributes inherited from DAObjFunc
const fvMesh & mesh_
 fvMesh More...
 
const DAOptiondaOption_
 DAOption object. More...
 
const DAModeldaModel_
 DAModel object. More...
 
const DAIndexdaIndex_
 DAIndex object. More...
 
const DAResidualdaResidual_
 DAResidual object. More...
 
word objFuncName_
 the name of the objective function More...
 
word objFuncPart_
 the part of the objective function More...
 
word objFuncType_
 the type of the objective function More...
 
const dictionary & objFuncDict_
 dictionary containing the information for the objective function More...
 
DAField daField_
 DAField object. More...
 
labelList objFuncFaceSources_
 a sorted list of all face sources for the objective function More...
 
labelList objFuncCellSources_
 a sorted list of all cell sources for the objective function More...
 
scalarList objFuncFaceValues_
 value of the obj function on the discrete faces More...
 
scalarList objFuncCellValues_
 value of the obj function in the discrete cells More...
 
scalar scale_
 scale of the objective function More...
 
scalar objFuncValue_
 the value of the objective function More...
 
List< List< word > > objFuncConInfo_
 the connectivity information for the objective function More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DAObjFunc
static autoPtr< DAObjFuncNew (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAResidual &daResidual, const word objFuncName, const word objFuncPart, const dictionary &objFuncDict)
 
- Public Attributes inherited from DAObjFunc
scalar expSumKS = 1.0
 expSumKS stores sum[exp(coeffKS*x_i)] for KS function which will be used to scale dFdW More...
 
label calcRefCoeffs = 1
 whether to compute reference coefficients for special objFunc treatment such as totalPressureRatio More...
 

Detailed Description

Definition at line 26 of file DAObjFuncTotalPressureRatio.H.

Constructor & Destructor Documentation

◆ DAObjFuncTotalPressureRatio()

DAObjFuncTotalPressureRatio ( const fvMesh &  mesh,
const DAOption daOption,
const DAModel daModel,
const DAIndex daIndex,
const DAResidual daResidual,
const word  objFuncName,
const word  objFuncPart,
const dictionary &  objFuncDict 
)

◆ ~DAObjFuncTotalPressureRatio()

virtual ~DAObjFuncTotalPressureRatio ( )
inlinevirtual

Definition at line 68 of file DAObjFuncTotalPressureRatio.H.

Member Function Documentation

◆ TypeName()

TypeName ( "totalPressureRatio"  )

◆ calcObjFunc()

void calcObjFunc ( const labelList &  objFuncFaceSources,
const labelList &  objFuncCellSources,
scalarList &  objFuncFaceValues,
scalarList &  objFuncCellValues,
scalar &  objFuncValue 
)
virtual

Member Data Documentation

◆ areaSumInlet_

scalar areaSumInlet_ = -9999.0
protected

the area of all inlet patches

Definition at line 33 of file DAObjFuncTotalPressureRatio.H.

Referenced by DAObjFuncTotalPressureRatio::calcObjFunc().

◆ areaSumOutlet_

scalar areaSumOutlet_ = -9999.0
protected

the area of all outlet patches

Definition at line 36 of file DAObjFuncTotalPressureRatio.H.

Referenced by DAObjFuncTotalPressureRatio::calcObjFunc().

◆ outletPatches_

wordList outletPatches_
protected

◆ inletPatches_

wordList inletPatches_
protected

◆ TPInRef_

scalar TPInRef_ = 0.0
protected

◆ TPOutRef_

scalar TPOutRef_ = 0.0
protected

◆ Cp_

scalar Cp_
protected

◆ gamma_

scalar gamma_
protected

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