morphFieldMapper.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) 2011 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::morphFieldMapper
29 
30 Description
31  Abstract base class to hold the Field mapping for mesh morphs.
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Foam_morphFieldMapper_H
36 #define Foam_morphFieldMapper_H
37 
38 #include "Field.H"
39 #include "Map.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class morphFieldMapper Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class morphFieldMapper
51 :
52  public FieldMapper
53 {
54 public:
55 
56  // Constructors
57 
58  //- Default construct
59  morphFieldMapper() = default;
60 
61 
62  //- Destructor
63  virtual ~morphFieldMapper() = default;
64 
65 
66  // Member Functions
67 
68  //- Return size of field before mapping
69  virtual label sizeBeforeMapping() const = 0;
70 
71  //- Are there any inserted objects
72  virtual bool insertedObjects() const = 0;
73 
74  //- Return list of inserted objects
75  virtual const labelList& insertedObjectLabels() const = 0;
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
virtual ~morphFieldMapper()=default
Destructor.
morphFieldMapper()=default
Default construct.
Abstract base class to hold the Field mapping for mesh morphs.
Abstract base class to hold the Field mapping addressing and weights.
Definition: FieldMapper.H:43
virtual bool insertedObjects() const =0
Are there any inserted objects.
virtual label sizeBeforeMapping() const =0
Return size of field before mapping.
virtual const labelList & insertedObjectLabels() const =0
Return list of inserted objects.
Namespace for OpenFOAM.