DAFunction.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Compute objective and constraint functions and their derivatives
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFunction_H
#define DAFunction_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "DAOption.H"
#include "DAModel.H"
#include "DAIndex.H"
#include "topoSetSource.H"
#include "topoSet.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAFunction Declaration
\*---------------------------------------------------------------------------*/
 
class DAFunction
{
 
private:
    DAFunction(const DAFunction&);
 
    void operator=(const DAFunction&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    word functionName_;
 
    word functionType_;
 
    word timeOp_;
 
    dictionary functionDict_;
 
    labelList faceSources_;
 
    labelList cellSources_;
 
    scalar scale_;
 
    label calcRefVar_;
 
    scalarList ref_;
 
public:
    TypeName("DAFunction");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAFunction,
        dictionary,
        (
            const fvMesh& mesh,
            const DAOption& daOption,
            const DAModel& daModel,
            const DAIndex& daIndex,
            const word functionName),
        (
            mesh,
            daOption,
            daModel,
            daIndex,
            functionName));
 
    // Constructors
 
    //- Construct from components
    DAFunction(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAFunction> New(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    //- Destructor
    virtual ~DAFunction()
    {
    }
 
    void clear()
    {
        faceSources_.clear();
        cellSources_.clear();
    }
 
    void calcFunctionSources();
 
    virtual scalar calcFunction() = 0;
 
    word getFunctionName()
    {
        return functionName_;
    }
 
    word getFunctionType()
    {
        return functionType_;
    }
 
    word getFunctionTimeOp()
    {
        return timeOp_;
    }
 
    const labelList& getFaceSources() const
    {
        return faceSources_;
    }
 
    const labelList& getCellSources() const
    {
        return cellSources_;
    }
 
    void calcRefVar(scalar& functionValue);
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //