morphFieldMapper.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::morphFieldMapper
26 
27 Description
28  Abstract base class to hold the Field mapping for mesh morphs.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef morphFieldMapper_H
33 #define morphFieldMapper_H
34 
35 #include "generalFieldMapper.H"
36 #include "Map.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class morphFieldMapper Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class morphFieldMapper
48 :
49  public generalFieldMapper
50 {
51 
52 public:
53 
54  // Constructors
55 
56  //- Null constructor
58  {}
59 
60 
61  //- Destructor
62  virtual ~morphFieldMapper()
63  {}
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()
Destructor.
morphFieldMapper()
Null constructor.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Abstract base class to hold the Field mapping for mesh morphs.
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.
General field mapper supporting both direct and weighted mapping.
Namespace for OpenFOAM.