All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
generalFieldMapper.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) 2019-2023 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::generalFieldMapper
26 
27 Description
28  General field mapper supporting both direct and weighted mapping.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef generalFieldMapper_H
33 #define generalFieldMapper_H
34 
35 #include "fieldMapper.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class generalFieldMapper Declaration
44 \*---------------------------------------------------------------------------*/
45 
47 :
48  public fieldMapper
49 {
50  // Private Member Functions
51 
52  //- Map a field in-place
53  template<class Type>
54  void map(Field<Type>& f, const Field<Type>& mapF) const;
55 
56  //- Map a field and return the result
57  template<class Type>
58  tmp<Field<Type>> map(const Field<Type>& f) const;
59 
60 
61 public:
62 
63  // Constructors
64 
65  //- Null constructor
67  {}
68 
69 
70  //- Destructor
71  virtual ~generalFieldMapper()
72  {}
73 
74 
75  // Member Functions
76 
77  //- Is the mapper direct?
78  virtual bool direct() const = 0;
79 
80  //- Access the direct addressing
81  virtual const labelUList& directAddressing() const;
82 
83  //- Access the general addressing
84  virtual const labelListList& addressing() const;
85 
86  //- Access the general weights
87  virtual const scalarListList& weights() const;
88 
89 
90  // Member Operators
91 
92  //- Map a field
94 
95  //- Map a label field
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
Abstract base class for field mapping.
Definition: fieldMapper.H:48
General field mapper supporting both direct and weighted mapping.
virtual const labelListList & addressing() const
Access the general addressing.
virtual const scalarListList & weights() const
Access the general weights.
virtual bool direct() const =0
Is the mapper direct?
virtual const labelUList & directAddressing() const
Access the direct addressing.
generalFieldMapper()
Null constructor.
DEFINE_FIELD_MAPPER_MAP_OPERATOR(label,)
Map a label field.
virtual ~generalFieldMapper()
Destructor.
FOR_ALL_FIELD_TYPES(DEFINE_FIELD_MAPPER_MAP_OPERATOR,)
Map a field.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
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
labelList f(nPoints)