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 | Copyright (C) 2011-2014 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 template<class SourcePatch, class TargetPatch>
27 inline Foam::label
29 {
30  return singlePatchProc_;
31 }
32 
33 
34 template<class SourcePatch, class TargetPatch>
35 inline Foam::scalar
37 {
38  return lowWeightCorrection_;
39 }
40 
41 
42 template<class SourcePatch, class TargetPatch>
43 inline bool
46 {
47  return lowWeightCorrection_ > 0;
48 }
49 
50 
51 template<class SourcePatch, class TargetPatch>
52 inline const Foam::scalarField&
54 {
55  return srcMagSf_;
56 }
57 
58 
59 template<class SourcePatch, class TargetPatch>
60 inline const Foam::labelListList&
62 {
63  return srcAddress_;
64 }
65 
66 
67 template<class SourcePatch, class TargetPatch>
68 inline const Foam::scalarListList&
70 {
71  return srcWeights_;
72 }
73 
74 
75 template<class SourcePatch, class TargetPatch>
76 inline const Foam::scalarField&
78 {
79  return srcWeightsSum_;
80 }
81 
82 
83 template<class SourcePatch, class TargetPatch>
84 inline const Foam::mapDistribute&
86 {
87  return srcMapPtr_();
88 }
89 
90 
91 template<class SourcePatch, class TargetPatch>
92 inline const Foam::scalarField&
94 {
95  return tgtMagSf_;
96 }
97 
98 
99 template<class SourcePatch, class TargetPatch>
100 inline const Foam::labelListList&
102 {
103  return tgtAddress_;
104 }
105 
106 
107 template<class SourcePatch, class TargetPatch>
108 inline const Foam::scalarListList&
110 {
111  return tgtWeights_;
112 }
113 
114 
115 template<class SourcePatch, class TargetPatch>
116 inline const Foam::scalarField&
118 {
119  return tgtWeightsSum_;
120 }
121 
122 
123 template<class SourcePatch, class TargetPatch>
124 inline const Foam::mapDistribute&
126 {
127  return tgtMapPtr_();
128 }
129 
130 
131 // ************************************************************************* //
Foam::AMIInterpolation::srcMagSf
const scalarField & srcMagSf() const
Return const access to source patch face areas.
Definition: AMIInterpolationI.H:53
Foam::AMIInterpolation::tgtWeightsSum
const scalarField & tgtWeightsSum() const
Return const access to normalisation factor of target.
Definition: AMIInterpolationI.H:117
Foam::AMIInterpolation::srcWeightsSum
const scalarField & srcWeightsSum() const
Return const access to normalisation factor of source.
Definition: AMIInterpolationI.H:77
Foam::AMIInterpolation::tgtAddress
const labelListList & tgtAddress() const
Return const access to target patch addressing.
Definition: AMIInterpolationI.H:101
Foam::AMIInterpolation::tgtWeights
const scalarListList & tgtWeights() const
Return const access to target patch weights.
Definition: AMIInterpolationI.H:109
Foam::AMIInterpolation::tgtMap
const mapDistribute & tgtMap() const
Target map pointer - valid only if singlePatchProc=-1.
Definition: AMIInterpolationI.H:125
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:59
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::mapDistribute
Class containing processor-to-processor mapping information.
Definition: mapDistribute.H:152
Foam::AMIInterpolation::singlePatchProc
label singlePatchProc() const
Set to -1, or the processor holding all faces (both sides) of.
Definition: AMIInterpolationI.H:28
Foam::AMIInterpolation::tgtMagSf
const scalarField & tgtMagSf() const
Return const access to target patch face areas.
Definition: AMIInterpolationI.H:93
Foam::AMIInterpolation::lowWeightCorrection
scalar lowWeightCorrection() const
Threshold weight below which interpolation is deactivated.
Definition: AMIInterpolationI.H:36
Foam::AMIInterpolation::srcMap
const mapDistribute & srcMap() const
Source map pointer - valid only if singlePatchProc = -1.
Definition: AMIInterpolationI.H:85
Foam::AMIInterpolation::applyLowWeightCorrection
bool applyLowWeightCorrection() const
Return true if employing a 'lowWeightCorrection'.
Definition: AMIInterpolationI.H:45
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:59
Foam::AMIInterpolation::srcAddress
const labelListList & srcAddress() const
Return const access to source patch addressing.
Definition: AMIInterpolationI.H:61
Foam::AMIInterpolation::srcWeights
const scalarListList & srcWeights() const
Return const access to source patch weights.
Definition: AMIInterpolationI.H:69