DAFunctionVariableVolSum.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Child class for variable volume sum
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFunctionVariableVolSum_H
#define DAFunctionVariableVolSum_H
 
#include "DAFunction.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DAFunctionVariableVolSum Declaration
\*---------------------------------------------------------------------------*/
 
class DAFunctionVariableVolSum
    : public DAFunction
{
 
protected:
    word varName_;
 
    word varType_;
 
    label index_;
 
    label isSquare_;
 
    label divByTotalVol_;
 
    label multiplyVol_;
 
public:
    TypeName("variableVolSum");
    // Constructors
 
    //- Construct from components
    DAFunctionVariableVolSum(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    //- Destructor
    virtual ~DAFunctionVariableVolSum()
    {
    }
 
    virtual scalar calcFunction();
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //