sensitivity.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019-2020 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 \*---------------------------------------------------------------------------*/
29 
30 #include "runTimeSelectionTables.H"
31 #include "sensitivity.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(sensitivity, 0);
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
43 Foam::sensitivity::sensitivity
44 (
45  const fvMesh& mesh,
46  const dictionary& dict
47 )
48 :
49  mesh_(mesh),
50  dict_(dict),
51  fieldSensPtr_(nullptr)
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * //
56 
58 {
59  return dict_;
60 }
61 
62 
64 {
65  dict_ = dict;
66 
67  return true;
68 }
69 
70 
72 {
73  // Does nothing
74 }
75 
76 
77 void Foam::sensitivity::write(const word& baseName)
78 {
79  if (fieldSensPtr_)
80  {
81  fieldSensPtr_->write();
82  }
83 }
84 
85 
86 // ************************************************************************* //
Foam::sensitivity::dict
const dictionary & dict() const
Return the construction dictionary.
Definition: sensitivity.C:57
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::sensitivity::readDict
virtual bool readDict(const dictionary &dict)
Read dictionary if changed.
Definition: sensitivity.C:63
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::sensitivity::dict_
dictionary dict_
Definition: sensitivity.H:70
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
sensitivity.H
Foam::sensitivity::write
virtual void write(const word &baseName=word::null)
Write sensitivity fields.
Definition: sensitivity.C:77
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::sensitivity::computeDerivativesSize
virtual void computeDerivativesSize()
Compute design variables number. Does nothing in the base.
Definition: sensitivity.C:71