optMeshMovementNULL.H
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 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 Class
29  Foam::optMeshMovementNULL
30 
31 Description
32  A dummy optMeshMovement object
33 
34 SourceFiles
35  optMeshMovementNULL.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef optMeshMovementNULL_H
40 #define optMeshMovementNULL_H
41 
42 #include "optMeshMovement.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class optMeshMovementNULL Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public optMeshMovement
56 {
57 private:
58 
59  // Private Member Functions
60 
61  //- No copy construct
63 
64  //- No copy assignment
65  void operator=(const optMeshMovementNULL&) = delete;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("none");
72 
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  fvMesh& mesh,
80  const dictionary& dict,
81  const labelList& patchIDs
82  );
83 
84 
85  //- Destructor
86  virtual ~optMeshMovementNULL() = default;
87 
88 
89  // Member Functions
90 
91  //- Calculates surface mesh movement
92  void moveMesh();
93 
94  //- Compute eta value based on max displacement
95  virtual scalar computeEta(const scalarField& correction);
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
Foam::optMeshMovementNULL::computeEta
virtual scalar computeEta(const scalarField &correction)
Compute eta value based on max displacement.
Definition: optMeshMovementNULL.C:69
Foam::optMeshMovementNULL::moveMesh
void moveMesh()
Calculates surface mesh movement.
Definition: optMeshMovementNULL.C:62
Foam::correction
tmp< fvMatrix< Type > > correction(const fvMatrix< Type > &)
Foam::optMeshMovementNULL::~optMeshMovementNULL
virtual ~optMeshMovementNULL()=default
Destructor.
Foam::Field< scalar >
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::optMeshMovementNULL
A dummy optMeshMovement object.
Definition: optMeshMovementNULL.H:52
Foam::optMeshMovementNULL::TypeName
TypeName("none")
Runtime type information.
Foam::List< label >
Foam::optMeshMovement
Abstract base class for translating an update of the design variables into mesh movement.
Definition: optMeshMovement.H:54
optMeshMovement.H