generalFieldMapper.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "generalFieldMapper.H"
27 
28 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
29 
30 template<class Type>
31 void Foam::generalFieldMapper::map
32 (
33  Field<Type>& f,
34  const Field<Type>& mapF
35 ) const
36 {
37  if (direct())
38  {
39  if (notNull(directAddressing()) && directAddressing().size())
40  {
41  f.map(mapF, directAddressing());
42  }
43  else
44  {
45  f.setSize(0);
46  }
47  }
48  else
49  {
50  if (notNull(addressing()) && addressing().size())
51  {
52  f.map(mapF, addressing(), weights());
53  }
54  else
55  {
56  f.setSize(0);
57  }
58  }
59 }
60 
61 
62 template<class Type>
63 Foam::tmp<Foam::Field<Type>> Foam::generalFieldMapper::map
64 (
65  const Field<Type>& mapF
66 ) const
67 {
69  (
70  new Field<Type>
71  (
72  direct() ? directAddressing().size() : addressing().size()
73  )
74  );
75  map(tf.ref(), mapF);
76  return tf;
77 }
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
83 {
85  << "attempt to access null direct addressing"
86  << abort(FatalError);
87 
88  return labelUList::null();
89 }
90 
91 
93 {
95  << "attempt to access null interpolation addressing"
96  << abort(FatalError);
97 
98  return labelListList::null();
99 }
100 
101 
103 {
105  << "attempt to access null interpolation weights"
106  << abort(FatalError);
107 
108  return scalarListList::null();
109 }
110 
111 
112 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
113 
115 
116 
118 
119 
120 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
static const List< labelList > & null()
Return a null List.
Definition: ListI.H:118
static const UList< label > & null()
Return a null UList.
Definition: UListI.H:51
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.
A class for managing temporary objects.
Definition: tmp.H:55
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
#define IMPLEMENT_FIELD_MAPPER_MAP_OPERATOR(Type, mapperType)
Definition: fieldMapperM.H:69
const tensorField & tf
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
errorManip< error > abort(error &err)
Definition: errorManip.H:131
bool notNull(const T &t)
Return true if t is not a reference to the nullObject of type T.
Definition: nullObjectI.H:64
error FatalError
FOR_ALL_FIELD_TYPES(makeFieldSourceTypedef)
labelList f(nPoints)