objectiveManager.H 5.69 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8 9 10
    Copyright (C) 2007-2019 PCOpt/NTUA
    Copyright (C) 2013-2019 FOSS GP
    Copyright (C) 2019 OpenCFD Ltd.
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::objectiveManager

Description
    class for managing incompressible objective functions.

SourceFiles
    objectiveManager.C

\*---------------------------------------------------------------------------*/

#ifndef objectiveManager_H
#define objectiveManager_H

#include "fvMesh.H"
#include "objective.H"
#include "runTimeSelectionTables.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                      Class objectiveManager Declaration
\*---------------------------------------------------------------------------*/

class objectiveManager
:
    public regIOobject
{
protected:

    // Protected data

        const fvMesh& mesh_;
        const dictionary& dict_;
        const word adjointSolverName_;
        const word primalSolverName_;
        PtrList<objective> objectives_;


private:

    // Private Member Functions

74
        //- No copy construct
75 76
        objectiveManager(const objectiveManager&) = delete;

77
        //- No copy assignment
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
        void operator=(const objectiveManager&) = delete;


public:

    TypeName("objectiveManager");

    // Declare run-time constructor selection table

        declareRunTimeSelectionTable
        (
            autoPtr,
            objectiveManager,
            dictionary,
            (
                const fvMesh& mesh,
                const dictionary& dict,
                const word& adjointSolverName,
                const word& primalSolverName
            ),
            (mesh, dict, adjointSolverName, primalSolverName)
        );

    // Constructors

        //- Construct from components
        objectiveManager
        (
            const fvMesh& mesh,
            const dictionary& dict,
            const word& adjointSolverName,
            const word& primalSolverName
        );

    // Selectors

        //- Return a reference to the selected turbulence model
        static autoPtr<objectiveManager> New
        (
            const fvMesh& mesh,
            const dictionary& dict,
            const word& adjointSolverName,
            const word& primalSolverName
        );


    //- Destructor
    virtual ~objectiveManager() = default;


    // Member Functions

        virtual bool readDict(const dictionary& dict);

        //- Update objective function related values
        void updateNormalizationFactor();

        //- Update objective function related values
        void update();

138 139 140
        //- Update contributions to adjoint if true, otherwise return nulls
        void updateOrNullify();

141
        //- Increment integration times by the optimisation cycle time-span
142 143
        void incrementIntegrationTimes(const scalar timeSpan);

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
        //- Print to screen
        scalar print();

        //- Write objective function history
        virtual bool write(const bool valid = true) const;

        //- Call all functions required prior to the solution of the adjoint
        //- equations
        void updateAndWrite();

        //- Return reference to objective functions
        PtrList<objective>& getObjectiveFunctions();

        //- Return constant reference to objective functions
        const PtrList<objective>& getObjectiveFunctions() const;

        //- Return name of adjointSolverManager
        const word& adjointSolverManagerName() const;

        //- Return name of the adjointSolver
        const word& adjointSolverName() const;

        //- Return name of the primalSolver
        const word& primalSolverName() const;

169 170 171
        //- Check integration times for unsteady runs
        void checkIntegrationTimes() const;

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
        //- Add contribution to adjoint momentum PDEs
        virtual void addUaEqnSource(fvVectorMatrix& UaEqn) = 0;

        //- Add contribution to adjoint momentum PDEs
        virtual void addPaEqnSource(fvScalarMatrix& paEqn) = 0;

        //- Add contribution to first adjoint turbulence model PDE
        virtual void addTMEqn1Source(fvScalarMatrix& adjTMEqn1) = 0;

        //- Add contribution to second adjoint turbulence model PDE
        virtual void addTMEqn2Source(fvScalarMatrix& adjTMEqn2) = 0;


    // IO

        virtual bool writeData(Ostream&) const
        {
            return true;
        }
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //