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

Public Member Functions

 TypeName ("totalPressureRatio")
 
 DAFunctionTotalPressureRatio (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)
 
virtual ~DAFunctionTotalPressureRatio ()
 
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

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 Cp_
 
scalar gamma_
 
- 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 DAFunctionTotalPressureRatio.H.

Constructor & Destructor Documentation

◆ DAFunctionTotalPressureRatio()

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

◆ ~DAFunctionTotalPressureRatio()

virtual ~DAFunctionTotalPressureRatio ( )
inlinevirtual

Definition at line 60 of file DAFunctionTotalPressureRatio.H.

Member Function Documentation

◆ TypeName()

TypeName ( "totalPressureRatio"  )

◆ calcFunction()

scalar calcFunction ( )
virtual

Member Data Documentation

◆ areaSumInlet_

scalar areaSumInlet_ = -9999.0
protected

the area of all inlet patches

Definition at line 32 of file DAFunctionTotalPressureRatio.H.

Referenced by DAFunctionTotalPressureRatio::calcFunction().

◆ areaSumOutlet_

scalar areaSumOutlet_ = -9999.0
protected

the area of all outlet patches

Definition at line 35 of file DAFunctionTotalPressureRatio.H.

Referenced by DAFunctionTotalPressureRatio::calcFunction().

◆ outletPatches_

wordList outletPatches_
protected

◆ inletPatches_

wordList inletPatches_
protected

◆ Cp_

scalar Cp_
protected

◆ gamma_

scalar gamma_
protected

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