AMIInterpolationI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9  Copyright (C) 2016 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 template<class SourcePatch, class TargetPatch>
30 inline Foam::label
32 {
33  return singlePatchProc_;
34 }
35 
36 
37 template<class SourcePatch, class TargetPatch>
38 inline Foam::scalar
40 {
41  return lowWeightCorrection_;
42 }
43 
44 
45 template<class SourcePatch, class TargetPatch>
46 inline bool
49 {
50  return lowWeightCorrection_ > 0;
51 }
52 
53 
54 template<class SourcePatch, class TargetPatch>
55 inline const Foam::List<Foam::scalar>&
57 {
58  return srcMagSf_;
59 }
60 
61 
62 template<class SourcePatch, class TargetPatch>
65 {
66  return srcMagSf_;
67 }
68 
69 
70 template<class SourcePatch, class TargetPatch>
71 inline const Foam::labelListList&
73 {
74  return srcAddress_;
75 }
76 
77 
78 template<class SourcePatch, class TargetPatch>
79 inline Foam::labelListList&
81 {
82  return srcAddress_;
83 }
84 
85 
86 template<class SourcePatch, class TargetPatch>
87 inline const Foam::scalarListList&
89 {
90  return srcWeights_;
91 }
92 
93 
94 template<class SourcePatch, class TargetPatch>
97 {
98  return srcWeights_;
99 }
100 
101 
102 template<class SourcePatch, class TargetPatch>
103 inline const Foam::scalarField&
105 {
106  return srcWeightsSum_;
107 }
108 
109 
110 template<class SourcePatch, class TargetPatch>
111 inline Foam::scalarField&
113 {
114  return srcWeightsSum_;
115 }
116 
117 
118 template<class SourcePatch, class TargetPatch>
119 inline const Foam::mapDistribute&
121 {
122  return *srcMapPtr_;
123 }
124 
125 
126 template<class SourcePatch, class TargetPatch>
127 inline const Foam::List<Foam::scalar>&
129 {
130  return tgtMagSf_;
131 }
132 
133 
134 template<class SourcePatch, class TargetPatch>
137 {
138  return tgtMagSf_;
139 }
140 
141 
142 template<class SourcePatch, class TargetPatch>
143 inline const Foam::labelListList&
145 {
146  return tgtAddress_;
147 }
148 
149 
150 template<class SourcePatch, class TargetPatch>
151 inline Foam::labelListList&
153 {
154  return tgtAddress_;
155 }
156 
157 
158 template<class SourcePatch, class TargetPatch>
159 inline const Foam::scalarListList&
161 {
162  return tgtWeights_;
163 }
164 
165 
166 template<class SourcePatch, class TargetPatch>
167 inline Foam::scalarListList&
169 {
170  return tgtWeights_;
171 }
172 
173 
174 template<class SourcePatch, class TargetPatch>
175 inline const Foam::scalarField&
177 {
178  return tgtWeightsSum_;
179 }
180 
181 
182 template<class SourcePatch, class TargetPatch>
183 inline Foam::scalarField&
185 {
186  return tgtWeightsSum_;
187 }
188 
189 
190 template<class SourcePatch, class TargetPatch>
191 inline const Foam::mapDistribute&
193 {
194  return *tgtMapPtr_;
195 }
196 
197 
198 // ************************************************************************* //
Foam::AMIInterpolation::tgtWeightsSum
const scalarField & tgtWeightsSum() const
Definition: AMIInterpolationI.H:176
Foam::AMIInterpolation::srcWeightsSum
const scalarField & srcWeightsSum() const
Definition: AMIInterpolationI.H:104
Foam::AMIInterpolation::tgtAddress
const labelListList & tgtAddress() const
Return const access to target patch addressing.
Definition: AMIInterpolationI.H:144
Foam::AMIInterpolation::tgtWeights
const scalarListList & tgtWeights() const
Return const access to target patch weights.
Definition: AMIInterpolationI.H:160
Foam::AMIInterpolation::tgtMap
const mapDistribute & tgtMap() const
Definition: AMIInterpolationI.H:192
Foam::label
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:62
Foam::Field< scalar >
Foam::mapDistribute
Class containing processor-to-processor mapping information.
Definition: mapDistribute.H:163
Foam::AMIInterpolation::singlePatchProc
label singlePatchProc() const
Definition: AMIInterpolationI.H:31
Foam::AMIInterpolation::srcMagSf
const List< scalar > & srcMagSf() const
Return const access to source patch face areas.
Definition: AMIInterpolationI.H:56
Foam::AMIInterpolation::lowWeightCorrection
scalar lowWeightCorrection() const
Threshold weight below which interpolation is deactivated.
Definition: AMIInterpolationI.H:39
Foam::AMIInterpolation::srcMap
const mapDistribute & srcMap() const
Definition: AMIInterpolationI.H:120
Foam::AMIInterpolation::applyLowWeightCorrection
bool applyLowWeightCorrection() const
Return true if employing a 'lowWeightCorrection'.
Definition: AMIInterpolationI.H:48
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:102
Foam::AMIInterpolation::tgtMagSf
const List< scalar > & tgtMagSf() const
Return const access to target patch face areas.
Definition: AMIInterpolationI.H:128
Foam::AMIInterpolation::srcAddress
const labelListList & srcAddress() const
Return const access to source patch addressing.
Definition: AMIInterpolationI.H:72
Foam::AMIInterpolation::srcWeights
const scalarListList & srcWeights() const
Return const access to source patch weights.
Definition: AMIInterpolationI.H:88