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

Public Member Functions

 TypeName ("moment")
 
 DAFunctionMoment (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
 
virtual ~DAFunctionMoment ()
 
virtual scalar calcFunction ()
 calculate the value of objective function More...
 
- Public Member Functions inherited from DAFunction
 TypeName ("DAFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DAFunction, dictionary,(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName),(mesh, daOption, daModel, daIndex, functionName))
 
 DAFunction (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
 
virtual ~DAFunction ()
 
void clear ()
 clear up members More...
 
void calcFunctionSources ()
 calculate DAFunction::faceSources_ and DAFunction::cellSources_ More...
 
word getFunctionName ()
 return the name of objective function More...
 
word getFunctionType ()
 return the part of objective function More...
 
word getFunctionTimeOp ()
 return the time operator such as final, sum, average, variance More...
 
const labelList & getFaceSources () const
 return DAFunction::faceSources_ More...
 
const labelList & getCellSources () const
 return DAFunction::cellSources_ More...
 
void calcRefVar (scalar &functionValue)
 calculate (var-ref)^2 More...
 

Protected Attributes

vector momentDir_
 the direction of the moment More...
 
vector momentCenter_
 the center of rotation for moment More...
 
const DATurbulenceModeldaTurb_
 DATurbulenceModel object. More...
 
- Protected Attributes inherited from DAFunction
const fvMesh & mesh_
 fvMesh More...
 
const DAOptiondaOption_
 DAOption object. More...
 
const DAModeldaModel_
 DAModel object. More...
 
const DAIndexdaIndex_
 DAIndex object. More...
 
word functionName_
 the name of the objective function More...
 
word functionType_
 the type of the objective function More...
 
word timeOp_
 time operator such as final, sum, or average More...
 
dictionary functionDict_
 dictionary containing the information for the objective function More...
 
labelList faceSources_
 a sorted list of all face sources for the objective function More...
 
labelList cellSources_
 a sorted list of all cell sources for the objective function More...
 
scalar scale_
 scale of the objective function More...
 
label calcRefVar_
 whether to calculate (obj-ref)^2 More...
 
scalarList ref_
 if calcRefVar_ is True, set the reference value list More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DAFunction
static autoPtr< DAFunctionNew (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
 

Detailed Description

Definition at line 26 of file DAFunctionMoment.H.

Constructor & Destructor Documentation

◆ DAFunctionMoment()

DAFunctionMoment ( const fvMesh &  mesh,
const DAOption daOption,
const DAModel daModel,
const DAIndex daIndex,
const word  functionName 
)

◆ ~DAFunctionMoment()

virtual ~DAFunctionMoment ( )
inlinevirtual

Definition at line 53 of file DAFunctionMoment.H.

Member Function Documentation

◆ TypeName()

TypeName ( "moment"  )

◆ calcFunction()

scalar calcFunction ( )
virtual

Member Data Documentation

◆ momentDir_

vector momentDir_
protected

the direction of the moment

Definition at line 32 of file DAFunctionMoment.H.

Referenced by DAFunctionMoment::calcFunction(), and DAFunctionMoment::DAFunctionMoment().

◆ momentCenter_

vector momentCenter_
protected

the center of rotation for moment

Definition at line 35 of file DAFunctionMoment.H.

Referenced by DAFunctionMoment::calcFunction(), and DAFunctionMoment::DAFunctionMoment().

◆ daTurb_

const DATurbulenceModel& daTurb_
protected

DATurbulenceModel object.

Definition at line 38 of file DAFunctionMoment.H.

Referenced by DAFunctionMoment::calcFunction().


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