SIBaseIncompressible.H 4.06 KB
Newer Older
1
2
3
4
5
6
7
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
8
9
    Copyright (C) 2007-2020 PCOpt/NTUA
    Copyright (C) 2013-2020 FOSS GP
10
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
    Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::incompressible::SIBase

Description
    Base class for Surface Integral-based sensitivity derivatives

SourceFiles
    SIBase.C

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

#ifndef SIBaseIncompressible_H
#define SIBaseIncompressible_H

43
#include "shapeSensitivitiesIncompressible.H"
44
45
46
47
48
49
50
51
52
53
54
#include "sensitivitySurfaceIncompressible.H"

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

namespace Foam
{

namespace incompressible
{

/*---------------------------------------------------------------------------*\
55
                            Class SIBase Declaration
56
57
58
59
\*---------------------------------------------------------------------------*/

class SIBase
:
60
    public shapeSensitivities
61
62
63
64
65
66
67
68
{
protected:

    // Protected data

        //- Surface sensitivities
        sensitivitySurface surfaceSensitivity_;

69
70
71
72
        //- Whether to include direct sensitivities or not.
        //  Used to avoid double contributions from both here and the
        //  sensitivitySurface object which might have already accounted for
        //  them
73
74
        bool includeObjective_;

75
76
77
        //- Write sensitivity map upon write
        bool writeSensitivityMap_;

78

79
    // Protected Member Functions
80

81
82
83
84
85
86
87
88
        //- Read options from dict
        void read();


private:

    // Private Member Functions

89
        //- No copy construct
90
91
        SIBase(const SIBase&) = delete;

92
        //- No copy assignment
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
        void operator=(const SIBase&) = delete;


public:

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


    // Constructors

        //- Construct from components
        SIBase
        (
            const fvMesh& mesh,
            const dictionary& dict,
            incompressibleVars& primalVars,
            incompressibleAdjointVars& adjointVars,
111
            objectiveManager& objectiveManager
112
113
114
115
116
117
118
119
120
121
122
        );


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


    // Member Functions

        //- Read dict if changed
        virtual bool readDict(const dictionary& dict);
123

124
125
126
        //- Accumulate sensitivity integrands
        virtual void accumulateIntegrand(const scalar dt);

127
        //- Assemble sensitivities
128
129
130
131
        virtual void assembleSensitivities() = 0;

        //- Zero sensitivity fields and their constituents
        virtual void clearSensitivities();
132
133
134
135
136
137

        //- Return reference to underlaying surface sensitivities
        const sensitivitySurface& getSurfaceSensitivities() const;

        //- Write sensitivity map
        virtual void write(const word& baseName = word::null);
138
139
140
141
142
143
144
145
146
147
148
149
150
};


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

} // End namespace incompressible
} // End namespace Foam

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

#endif

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