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

Public Member Functions

 TypeName ("force")
 
 DAObjFuncForce (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 ~DAObjFuncForce ()
 
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 Member Functions

void updateForceDir (vector &forceDir)
 dynamically adjust the force direction More...
 

Protected Attributes

vector forceDir_
 the direction of the force More...
 
word dirMode_
 if dynamically adjusting the angle what mode to use More...
 
word inoutRefPatchName_
 the reference patch name from the alpha design variable dict patches[0] from which we compute the flow direction More...
 
label flowAxisIndex_
 flowAxisIndex_ for the alpha design variable with tan(U_normal/U_flow) More...
 
label normalAxisIndex_
 normalAxisIndex_ for the alpha design variable with tan(U_normal/U_flow) More...
 
const DATurbulenceModeldaTurb_
 DATurbulenceModel object. More...
 
- 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 DAObjFuncForce.H.

Constructor & Destructor Documentation

◆ DAObjFuncForce()

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

◆ ~DAObjFuncForce()

virtual ~DAObjFuncForce ( )
inlinevirtual

Definition at line 68 of file DAObjFuncForce.H.

Member Function Documentation

◆ updateForceDir()

void updateForceDir ( vector &  forceDir)
protected

dynamically adjust the force direction

Definition at line 196 of file DAObjFuncForce.C.

References DAUtility::angleOfAttackRadForwardAD, DAObjFuncForce::dirMode_, DAObjFuncForce::flowAxisIndex_, DAObjFuncForce::inoutRefPatchName_, DAObjFunc::mesh_, DAObjFuncForce::normalAxisIndex_, and U.

Referenced by DAObjFuncForce::calcObjFunc().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "force"  )

◆ calcObjFunc()

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

Member Data Documentation

◆ forceDir_

vector forceDir_
protected

the direction of the force

Definition at line 32 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::calcObjFunc(), and DAObjFuncForce::DAObjFuncForce().

◆ dirMode_

word dirMode_
protected

if dynamically adjusting the angle what mode to use

Definition at line 35 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::calcObjFunc(), DAObjFuncForce::DAObjFuncForce(), and DAObjFuncForce::updateForceDir().

◆ inoutRefPatchName_

word inoutRefPatchName_
protected

the reference patch name from the alpha design variable dict patches[0] from which we compute the flow direction

Definition at line 38 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::DAObjFuncForce(), and DAObjFuncForce::updateForceDir().

◆ flowAxisIndex_

label flowAxisIndex_
protected

flowAxisIndex_ for the alpha design variable with tan(U_normal/U_flow)

Definition at line 41 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::DAObjFuncForce(), and DAObjFuncForce::updateForceDir().

◆ normalAxisIndex_

label normalAxisIndex_
protected

normalAxisIndex_ for the alpha design variable with tan(U_normal/U_flow)

Definition at line 44 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::DAObjFuncForce(), and DAObjFuncForce::updateForceDir().

◆ daTurb_

const DATurbulenceModel& daTurb_
protected

DATurbulenceModel object.

Definition at line 50 of file DAObjFuncForce.H.

Referenced by DAObjFuncForce::calcObjFunc().


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