DAFunctionVariance.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Child class for variance
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFunctionVariance_H
#define DAFunctionVariance_H
 
#include "DAFunction.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DAFunctionVariance Declaration
\*---------------------------------------------------------------------------*/
 
class DAFunctionVariance
    : public DAFunction
{
 
protected:
    word varName_;
 
    word mode_;
 
    word varType_;
 
    List<label> indices_;
 
    labelList probeCellIndex_;
 
    List<List<scalar>> probePointCoords_;
 
    word probePointMethod_;
 
    List<word> surfaceNames_;
 
    List<List<scalar>> refValue_;
 
    label nRefPoints_ = 0;
 
    scalar varUpperBound_;
 
    label isRefData_;
 
    label timeDependentRefData_;
 
    DATurbulenceModel& daTurb_;
 
    scalar Cp_ = -9999.0;
 
public:
    TypeName("variance");
    // Constructors
 
    //- Construct from components
    DAFunctionVariance(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    //- Destructor
    virtual ~DAFunctionVariance()
    {
    }
 
    virtual scalar calcFunction();
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //