LagrangianSubMeshI.H
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) 2025 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 "LagrangianSubMesh.H"
27 
28 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
29 
31 {
32  return mesh_;
33 }
34 
35 
37 {
38  return group_;
39 }
40 
41 
43 {
44  return size_;
45 }
46 
47 
49 {
50  return returnReduce(size_, sumOp<label>());
51 }
52 
53 
55 (
56  const LagrangianSubMesh& subMesh
57 )
58 {
59  return subMesh.size_;
60 }
61 
62 
63 inline bool Foam::LagrangianSubMesh::empty() const
64 {
65  return !size_;
66 }
67 
68 
70 {
71  return start_;
72 }
73 
74 
76 {
77  return start_ + size_;
78 }
79 
80 
82 {
83  return index_;
84 }
85 
86 
87 // ************************************************************************* //
Class containing Lagrangian geometry and topology.
Mesh that relates to a sub-section of a Lagrangian mesh. This is used to construct fields that relate...
LagrangianGroup group() const
Return the group.
label size() const
Return size.
label end() const
Return end.
bool empty() const
Return whether or not the mesh is empty.
label index() const
Return the index.
const LagrangianMesh & mesh() const
Return the mesh.
label globalSize() const
Return size.
label start() const
Return start.
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
T returnReduce(const T &Value, const BinaryOp &bop, const int tag=Pstream::msgType(), const label comm=UPstream::worldComm)
LagrangianGroup
Lagrangian group enumeration.