DAObjFunc.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Compute object functions and their derivatives
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAObjFunc_H
#define DAObjFunc_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "DAOption.H"
#include "DAModel.H"
#include "DAIndex.H"
#include "topoSetSource.H"
#include "topoSet.H"
#include "DAField.H"
#include "DAResidual.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAObjFunc Declaration
\*---------------------------------------------------------------------------*/
 
class DAObjFunc
{
 
private:
    DAObjFunc(const DAObjFunc&);
 
    void operator=(const DAObjFunc&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    const DAResidual& daResidual_;
 
    word objFuncName_;
 
    word objFuncPart_;
 
    word objFuncType_;
 
    const dictionary& objFuncDict_;
 
    DAField daField_;
 
    labelList objFuncFaceSources_;
 
    labelList objFuncCellSources_;
 
    scalarList objFuncFaceValues_;
 
    scalarList objFuncCellValues_;
 
    scalar scale_;
 
    scalar objFuncValue_;
 
    List<List<word>> objFuncConInfo_;
 
public:
    TypeName("DAObjFunc");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAObjFunc,
        dictionary,
        (
            const fvMesh& mesh,
            const DAOption& daOption,
            const DAModel& daModel,
            const DAIndex& daIndex,
            const DAResidual& daResidual,
            const word objFuncName,
            const word objFuncPart,
            const dictionary& objFuncDict),
        (
            mesh,
            daOption,
            daModel,
            daIndex,
            daResidual,
            objFuncName,
            objFuncPart,
            objFuncDict));
 
    // Constructors
 
    //- Construct from components
    DAObjFunc(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const DAResidual& daResidual,
        const word objFuncName,
        const word objFuncPart,
        const dictionary& objFuncDict);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAObjFunc> New(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const DAResidual& daResidual,
        const word objFuncName,
        const word objFuncPart,
        const dictionary& objFuncDict);
 
    //- Destructor
    virtual ~DAObjFunc()
    {
    }
 
    void clear()
    {
        objFuncFaceSources_.clear();
        objFuncCellSources_.clear();
        objFuncFaceValues_.clear();
        objFuncCellValues_.clear();
        objFuncConInfo_.clear();
    }
 
    void calcObjFuncSources(
        labelList& faceSources,
        labelList& cellSources);
 
    virtual void calcObjFunc(
        const labelList& objFuncFaceSources,
        const labelList& objFuncCellSources,
        scalarList& objFuncFaceValues,
        scalarList& objFuncCellValues,
        scalar& objFuncValue) = 0;
 
    scalar getObjFuncValue();
 
    scalar masterFunction(
        const dictionary& options,
        const Vec xvVec,
        const Vec wVec);
 
    word getObjFuncName()
    {
        return objFuncName_;
    }
 
    word getObjFuncPart()
    {
        return objFuncPart_;
    }
 
    word getObjFuncType()
    {
        return objFuncType_;
    }
 
    const labelList& getObjFuncFaceSources() const
    {
        return objFuncFaceSources_;
    }
 
    const labelList& getObjFuncCellSources() const
    {
        return objFuncCellSources_;
    }
 
    const scalarList& getObjFuncFaceValues() const
    {
        return objFuncFaceValues_;
    }
 
    const scalarList& getObjFuncCellValues() const
    {
        return objFuncCellValues_;
    }
 
    const List<List<word>>& getObjFuncConInfo() const
    {
        return objFuncConInfo_;
    }
 
    scalar expSumKS = 1.0;
 
    label calcRefCoeffs = 1;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //