betaMaxStepRamp Class Reference

Computes the betaMax using a stepRamp function which updates itself based on the current time. More...

Inheritance diagram for betaMaxStepRamp:
Collaboration diagram for betaMaxStepRamp:

Public Member Functions

 TypeName ("stepRamp")
 Runtime type information. More...
 
 betaMaxStepRamp (const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~betaMaxStepRamp ()=default
 Destructor. More...
 
virtual scalar value () const
 Get value. More...
 
- Public Member Functions inherited from betaMax
 TypeName ("betaMax")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, betaMax, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 betaMax (const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~betaMax ()=default
 Destructor. More...
 

Protected Attributes

scalar betaMin_
 Minimum betaMax value (to be used at the first opt cycles) More...
 
autoPtr< Function1< scalar > > funcPtr_
 The step ramp function. More...
 
- Protected Attributes inherited from betaMax
const fvMeshmesh_
 Reference to mesh. More...
 
scalar value_
 betaMax value More...
 

Additional Inherited Members

- Static Public Member Functions inherited from betaMax
static autoPtr< betaMaxNew (const fvMesh &mesh, const dictionary &dict)
 Construct and return the selected betaMax model. More...
 
- Protected Member Functions inherited from betaMax
scalar computeLength (const dictionary &dict) const
 Compute the characteristic length. More...
 
boolList markProcessorEdges (const polyPatch &patch) const
 Mark all common inlet - processor edges. More...
 

Detailed Description

Computes the betaMax using a stepRamp function which updates itself based on the current time.

Definition at line 45 of file betaMaxStepRamp.H.

Constructor & Destructor Documentation

◆ betaMaxStepRamp()

betaMaxStepRamp ( const fvMesh mesh,
const dictionary dict 
)

Construct from components.

Definition at line 41 of file betaMaxStepRamp.C.

References DebugInfo, dict, and Foam::endl().

Here is the call graph for this function:

◆ ~betaMaxStepRamp()

virtual ~betaMaxStepRamp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "stepRamp"  )

Runtime type information.

◆ value()

Foam::scalar value ( ) const
virtual

Get value.

Reimplemented from betaMax.

Definition at line 61 of file betaMaxStepRamp.C.

References betaMaxStepRamp::betaMin_, DebugInfo, Foam::endl(), betaMaxStepRamp::funcPtr_, betaMax::mesh_, fvMesh::time(), TimeState::timeOutputValue(), and betaMax::value_.

Here is the call graph for this function:

Member Data Documentation

◆ betaMin_

scalar betaMin_
protected

Minimum betaMax value (to be used at the first opt cycles)

Definition at line 71 of file betaMaxStepRamp.H.

Referenced by betaMaxStepRamp::value().

◆ funcPtr_

autoPtr<Function1<scalar> > funcPtr_
protected

The step ramp function.

Definition at line 76 of file betaMaxStepRamp.H.

Referenced by betaMaxStepRamp::value().


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