meshToMeshI.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) 2012-2014 OpenFOAM Foundation
9  Copyright (C) 2016-2023 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 #include "meshToMesh.H"
30 
31 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
32 
33 inline const Foam::polyMesh& Foam::meshToMesh::srcRegion() const
34 {
35  return srcRegion_;
36 }
37 
38 
39 inline const Foam::polyMesh& Foam::meshToMesh::tgtRegion() const
40 {
41  return tgtRegion_;
42 }
43 
44 
46 {
47  return srcToTgtCellAddr_;
48 }
49 
50 
52 {
53  return tgtToSrcCellAddr_;
54 }
55 
56 
58 {
59  return srcToTgtCellWght_;
60 }
61 
62 
64 {
65  return tgtToSrcCellWght_;
66 }
67 
68 
70 {
71  return srcToTgtCellVec_;
72 }
73 
74 
76 {
77  return tgtToSrcCellVec_;
78 }
79 
80 
81 inline Foam::scalar Foam::meshToMesh::V() const
82 {
83  return V_;
84 }
85 
86 
88 {
89  return (singleMeshProc_ == -1);
90 }
91 
92 
93 inline const Foam::mapDistribute*
95 {
96  return srcMapPtr_.get();
97 }
98 
99 
100 inline const Foam::mapDistribute*
102 {
103  return tgtMapPtr_.get();
104 }
105 
106 
109 {
110  return srcMapPtr_;
111 }
112 
113 
116 {
117  return tgtMapPtr_;
118 }
119 
120 
123 {
124  return patchAMIs_;
125 }
126 
127 
128 // ************************************************************************* //
bool distributed() const noexcept
Distributed across processors (singleMeshProc == -1)
Definition: meshToMeshI.H:80
const polyMesh & srcRegion() const
Return const access to the source mesh.
Definition: meshToMeshI.H:26
const PtrList< AMIPatchToPatchInterpolation > & patchAMIs() const
Return the list of AMIs between source and target patches.
Definition: meshToMeshI.H:115
const labelListList & srcToTgtCellAddr() const
Return const access to the source to target cell addressing.
Definition: meshToMeshI.H:38
const autoPtr< mapDistribute > & srcMap() const noexcept
Source map pointer - valid if no singleMeshProc.
Definition: meshToMeshI.H:101
const pointListList & tgtToSrcCellVec() const
Return const access to the target to source offset vectors.
Definition: meshToMeshI.H:68
scalar V() const
Return const access to the overlap volume.
Definition: meshToMeshI.H:74
const mapDistribute * hasSrcMap() const noexcept
Pointer to the source map (if distributed). Can be checked as a bool.
Definition: meshToMeshI.H:87
const direction noexcept
Definition: Scalar.H:258
const mapDistribute * hasTgtMap() const noexcept
Pointer to the target map (if distributed). Can be checked as a bool.
Definition: meshToMeshI.H:94
const labelListList & tgtToSrcCellAddr() const
Return const access to the target to source cell addressing.
Definition: meshToMeshI.H:44
Class containing processor-to-processor mapping information.
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers...
Definition: List.H:55
const autoPtr< mapDistribute > & tgtMap() const noexcept
Target map pointer - valid if no singleMeshProc.
Definition: meshToMeshI.H:108
const scalarListList & srcToTgtCellWght() const
Return const access to the source to target cell weights.
Definition: meshToMeshI.H:50
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & tgtRegion() const
Return const access to the target mesh.
Definition: meshToMeshI.H:32
const pointListList & srcToTgtCellVec() const
Return const access to the source to target offset vectors.
Definition: meshToMeshI.H:62
const scalarListList & tgtToSrcCellWght() const
Return const access to the target to source cell weights.
Definition: meshToMeshI.H:56