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 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  Field sizing mapper which sets the field size and does not 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  virtual public fieldMapper
49 {
50  // Private member data
51 
52  //- The size the mapper will set the fields to have
53  label size_;
54 
55 
56  // Private Member Functions
57 
58  template<class Type>
59  void setSize(Field<Type>& f) const;
60 
61  template<class Type>
62  tmp<Field<Type>> setSize() const;
63 
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct given size
70  setSizeFieldMapper(const label size);
71 
72 
73  //- Destructor
74  virtual ~setSizeFieldMapper()
75  {}
76 
77 
78  // Member Functions
79 
80  //- All values are unmapped
81  virtual bool hasUnmapped() const
82  {
83  return true;
84  }
85 
86 
87  // Member Operators
88 
89  virtual void operator()
90  (
92  const Field<scalar>& mapF
93  ) const;
94 
95  virtual void operator()
96  (
98  const Field<vector>& mapF
99  ) const;
100 
101  virtual void operator()
102  (
104  const Field<sphericalTensor>& mapF
105  ) const;
106 
107  virtual void operator()
108  (
110  const Field<symmTensor>& mapF
111  ) const;
112 
113  virtual void operator()
114  (
115  Field<tensor>& f,
116  const Field<tensor>& mapF
117  ) const;
118 
119 
120  virtual tmp<Field<scalar>> operator()
121  (
122  const Field<scalar>& mapF
123  ) const;
124 
125  virtual tmp<Field<vector>> operator()
126  (
127  const Field<vector>& mapF
128  ) const;
129 
130  virtual tmp<Field<sphericalTensor>> operator()
131  (
132  const Field<sphericalTensor>& mapF
133  ) const;
134 
135  virtual tmp<Field<symmTensor>> operator()
136  (
137  const Field<symmTensor>& mapF
138  ) const;
139 
140  virtual tmp<Field<tensor>> operator()
141  (
142  const Field<tensor>& mapF
143  ) const;
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #ifdef NoRepository
155 #endif
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #endif
160 
161 // ************************************************************************* //
setSizeFieldMapper(const label size)
Construct given size.
virtual ~setSizeFieldMapper()
Destructor.
Field sizing mapper which sets the field size and does not map values.
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
Pre-declare SubField and related Field type.
Definition: Field.H:56
Abstract base class for field mapping.
Definition: fieldMapper.H:45
virtual bool hasUnmapped() const
All values are unmapped.
labelList f(nPoints)
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.