faceBox.C
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) 2017-2023 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "faceBox.H"
29 #include "mapDistribute.H"
30 
31 namespace Foam
32 {
33 namespace processorLODs
34 {
36 }
37 }
38 
39 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
40 
42 (
43  const label srcObji
44 ) const
45 {
46  return treeBoundBox(srcPoints_, srcFaces_[srcObji]); // No reduce
47 }
48 
49 
51 (
52  const label tgtObji
53 ) const
54 {
55  return treeBoundBox(tgtPoints_, tgtFaces_[tgtObji]); // No reduce
56 }
57 
58 
59 // * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * * //
60 
62 (
63  const faceList& srcFaces,
64  const UList<point>& srcPoints,
65  const faceList& tgtFaces,
66  const UList<point>& tgtPoints,
67  const label maxObjectsPerLeaf,
68  const label nObjectsOfType,
69  const label nRefineIterMax
70 )
71 :
72  processorLODs::box(srcPoints, tgtPoints, maxObjectsPerLeaf, nObjectsOfType),
73  srcFaces_(srcFaces),
74  tgtFaces_(tgtFaces)
75 {}
76 
77 
78 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
79 
82 (
83  const mapDistributeBase::layoutTypes constructLayout
84 )
85 {
86  return createMap(srcFaces_.size(), tgtFaces_.size(), constructLayout);
87 }
88 
89 
90 // ************************************************************************* //
defineTypeNameAndDebug(box, 0)
layoutTypes
The map layout (eg, of the constructMap)
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:105
Creates the parallel distribution map by describing the source and target objects using box shapes...
Definition: box.H:52
faceBox(const faceList &srcFaces, const UList< point > &srcPoints, const faceList &tgtFaces, const UList< point > &tgtPoints, const label maxObjectsPerLeaf, const label nObjectsOfType, const label nRefineIterMax=100)
Construct from list of points/faces for source and target.
Definition: faceBox.C:55
virtual treeBoundBox calcSrcBox(const label srcObji) const
The local boundBox associated with given source object.
Definition: faceBox.C:35
virtual treeBoundBox calcTgtBox(const label tgtObji) const
The local boundBox associated with given target object.
Definition: faceBox.C:44
virtual autoPtr< mapDistribute > map(const mapDistributeBase::layoutTypes constructLayout)
Return the parallel distribution map (usually linear construct order)
Definition: faceBox.C:75
const UList< point > & srcPoints_
Reference to the source points.
Definition: box.H:81
Creates the parallel distribution map by describing the source and target objects using box shapes...
Definition: faceBox.H:50
Standard boundBox with extra functionality for use in octree.
Definition: treeBoundBox.H:90
const faceList & srcFaces_
Reference to the source face list.
Definition: faceBox.H:61
Namespace for OpenFOAM.