Loading...
Searching...
No Matches
betaMaxStepRamp Class Reference

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

#include <betaMaxStepRamp.H>

Inheritance diagram for betaMaxStepRamp:
Collaboration diagram for betaMaxStepRamp:

Public Member Functions

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

Protected Attributes

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

Additional Inherited Members

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

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 40 of file betaMaxStepRamp.C.

References betaMin_, DebugInfo, dict, Foam::endl(), funcPtr_, mesh, and Foam::Zero.

Here is the call graph for this function:

◆ ~betaMaxStepRamp()

virtual ~betaMaxStepRamp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "stepRamp" )

Runtime type information.

References dict, and mesh.

◆ value()

Foam::scalar value ( ) const
virtual

Get value.

Reimplemented from betaMax.

Definition at line 61 of file betaMaxStepRamp.C.

References betaMin_, DebugInfo, Foam::endl(), funcPtr_, betaMax::mesh_, value(), and betaMax::value_.

Referenced by value().

Here is the call graph for this function:
Here is the caller 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(), and value().

◆ funcPtr_

autoPtr<Function1<scalar> > funcPtr_
protected

The step ramp function.

Definition at line 76 of file betaMaxStepRamp.H.

Referenced by betaMaxStepRamp(), and value().


The documentation for this class was generated from the following files:
  • src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/betaMax/stepRamp/betaMaxStepRamp.H
  • src/optimisation/adjointOptimisation/adjoint/optimisation/designVariables/topODesignVariables/betaMax/stepRamp/betaMaxStepRamp.C