LagrangiancAccumulate.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 InNamespace
25  Foam::Lagrangianc
26 
27 Description
28  Functions for accumulating Lagrangian values into cell fields
29 
30 SourceFiles
31  LagrangiancAccumulate.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef LagrangiancAccumulate_H
36 #define LagrangiancAccumulate_H
37 
38 #include "LagrangianFieldsFwd.H"
39 #include "LagrangianSubFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Namespace Lagrangianc functions Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 namespace Lagrangianc
51 {
52  template<class CellMesh, class Type, template<class> class PrimitiveField>
54  (
56  const word& name
57  );
58 
59  template<class CellMesh, class Type, template<class> class PrimitiveField>
61  (
63  );
64 
65  template<class CellMesh, class Type, template<class> class PrimitiveField>
66  void accumulate
67  (
70  );
71 
72  template<class CellMesh, class Type, template<class> class PrimitiveField>
73  void accumulate
74  (
77  const word& name
78  );
79 }
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 } // End namespace Foam
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #ifdef NoRepository
88  #include "LagrangiancAccumulate.C"
89 #endif
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
tmp< DimensionedField< Type, CellMesh > > accumulate(const DimensionedField< Type, LagrangianMesh, PrimitiveField > &lPsi, const word &name)
Namespace for OpenFOAM.
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.