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

Public Member Functions

 TypeName ("maxKS")
 
 DATimeOpMaxKS (const word timeOpType, const dictionary options)
 
virtual ~DATimeOpMaxKS ()
 
virtual scalar compute (const scalarList &valList, const label iStart, const label iEnd)
 compute the timeOp value based on valList More...
 
virtual scalar dFScaling (const scalarList &valList, const label iStart, const label iEnd, const label timeIdx)
 compute the scaling factor for dF/d? calculation. More...
 
- Public Member Functions inherited from DATimeOp
 TypeName ("DATimeOp")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DATimeOp, dictionary,(const word timeOpType, const dictionary options),(timeOpType, options))
 
 DATimeOp (const word timeOpType, const dictionary options)
 
virtual ~DATimeOp ()
 

Protected Attributes

scalar coeffKS_
 the KS coefficient More...
 
- Protected Attributes inherited from DATimeOp
const word timeOpType_
 type of the timeOp More...
 
const dictionary options_
 a dictionary option from DAFunction More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DATimeOp
static autoPtr< DATimeOpNew (const word timeOpType, const dictionary options)
 

Detailed Description

Definition at line 29 of file DATimeOpMaxKS.H.

Constructor & Destructor Documentation

◆ DATimeOpMaxKS()

DATimeOpMaxKS ( const word  timeOpType,
const dictionary  options 
)

Definition at line 19 of file DATimeOpMaxKS.C.

References DATimeOpMaxKS::coeffKS_.

◆ ~DATimeOpMaxKS()

virtual ~DATimeOpMaxKS ( )
inlinevirtual

Definition at line 47 of file DATimeOpMaxKS.H.

Member Function Documentation

◆ TypeName()

TypeName ( "maxKS"  )

◆ compute()

scalar compute ( const scalarList &  valList,
const label  iStart,
const label  iEnd 
)
virtual

compute the timeOp value based on valList

Implements DATimeOp.

Definition at line 27 of file DATimeOpMaxKS.C.

References DATimeOpMaxKS::coeffKS_.

◆ dFScaling()

scalar dFScaling ( const scalarList &  valList,
const label  iStart,
const label  iEnd,
const label  timeIdx 
)
virtual

compute the scaling factor for dF/d? calculation.

Implements DATimeOp.

Definition at line 49 of file DATimeOpMaxKS.C.

References DATimeOpMaxKS::coeffKS_.

Member Data Documentation

◆ coeffKS_

scalar coeffKS_
protected

the KS coefficient

Definition at line 35 of file DATimeOpMaxKS.H.

Referenced by DATimeOpMaxKS::compute(), DATimeOpMaxKS::DATimeOpMaxKS(), and DATimeOpMaxKS::dFScaling().


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