setSizeFieldMapper.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::setSizeFieldMapper
26 
27 Description
28  Mapper which sets the field size. It does not actually map values.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef setSizeFieldMapper_H
33 #define setSizeFieldMapper_H
34 
35 #include "fieldMapper.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class setSizeFieldMapper Declaration
44 \*---------------------------------------------------------------------------*/
45 
47 :
48  public fieldMapper
49 {
50  // Private Data
51 
52  //- The size the mapper will set the fields to have
53  const label size_;
54 
55 
56  // Private Member Functions
57 
58  //- Map a field in-place
59  template<class Type>
60  void map(Field<Type>& f, const Field<Type>&) const;
61 
62  //- Map a field and return the result
63  template<class Type>
64  tmp<Field<Type>> map(const Field<Type>&) const;
65 
66 
67 public:
68 
69  // Constructors
70 
71  //- Construct given size
72  setSizeFieldMapper(const label size)
73  :
74  size_(size)
75  {}
76 
77 
78  //- Destructor
79  virtual ~setSizeFieldMapper()
80  {}
81 
82 
83  // Member Operators
84 
85  //- Map a field
87 
88  //- Map a label field
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
Abstract base class for field mapping.
Definition: fieldMapper.H:48
Mapper which sets the field size. It does not actually map values.
DEFINE_FIELD_MAPPER_MAP_OPERATOR(label,)
Map a label field.
setSizeFieldMapper(const label size)
Construct given size.
virtual ~setSizeFieldMapper()
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)