stepUpdate.H 3.5 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
-------------------------------------------------------------------------------
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::stepUpdate

Description
33
    Abstract base class for step update methods used in line search
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

SourceFiles
    stepUpdate.C

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

#ifndef stepUpdate_H
#define stepUpdate_H

#include "runTimeSelectionTables.H"
#include "dictionary.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
52
                          Class stepUpdate Declaration
53 54 55 56 57 58 59 60 61 62 63
\*---------------------------------------------------------------------------*/

class stepUpdate
{
protected:

    // Protected data

        const dictionary dict_;


64
    // Protected Member Functions
65

66 67 68 69
        //- Optional coeffs dict
        const dictionary& coeffsDict();


70 71 72 73
private:

    // Private Member Functions

74
        //- No copy construct
75 76
        stepUpdate(const stepUpdate&);

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
        void operator=(const stepUpdate&);


public:

    //- Runtime type information
    TypeName("stepUpdate");


    // Declare run-time constructor selection table

        declareRunTimeSelectionTable
        (
            autoPtr,
            stepUpdate,
            dictionary,
            (
                const dictionary& dict
            ),
            (dict)
        );


    // Constructors

        //- Construct from components
        stepUpdate(const dictionary& dict);


    // Selectors

        //- Return a reference to the selected turbulence model
        static autoPtr<stepUpdate> New(const dictionary& dict);


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


    // Member Functions

       //- Update the line search step
       virtual void updateStep(scalar& step) = 0;

       //- Set objective derivative
       virtual void setDeriv(const scalar deriv);

125
       //- Set new merit value
126 127
       virtual void setNewMeritValue(const scalar value);

128
       //- Set old merit value
129 130 131 132 133 134 135 136 137 138 139 140 141
       virtual void setOldMeritValue(const scalar value);
};


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

} // End namespace Foam

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

#endif

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