NaNLagrangianFieldSource.C
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 
27 
28 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
29 
30 template<class Type>
33 {}
34 
35 
36 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
37 
38 template<class Type>
41 (
42  const LagrangianSource& source,
43  const LagrangianSubMesh& subMesh
44 ) const
45 {
46  return
48  (
49  this->internalField().name() + ":" + source.name() + "Coeff",
50  subMesh,
52  (
53  "NaN",
54  this->internalDimensions(),
56  )
57  );
58 }
59 
60 
61 template<class Type>
64 (
65  const LagrangianSource& source,
66  const LagrangianSubMesh& subMesh
67 ) const
68 {
69  return
71  (
72  this->internalField().name() + ":" + source.name() + "Coeff",
73  subMesh,
75  (
76  "NaN",
77  dimless,
79  )
80  );
81 }
82 
83 
84 template<class Type>
87 (
88  const LagrangianInjection& injection,
89  const LagrangianSubMesh& subMesh
90 ) const
91 {
92  return
94  (
95  this->internalField().name() + ":" + injection.name() + "Coeff",
96  subMesh,
98  (
99  "NaN",
100  this->internalDimensions(),
102  )
103  );
104 }
105 
106 
107 // ************************************************************************* //
Base class for Lagrangian injections. Minimal wrapper over LagrangianSource. Implements some utility ...
const word & name() const
The source name.
Base class for Lagrangian sources. Minimal wrapper over LagrangianModel that provides an interface to...
Mesh that relates to a sub-section of a Lagrangian mesh. This is used to construct fields that relate...
virtual ~NaNLagrangianFieldSource()
Destructor.
virtual tmp< LagrangianSubField< Type > > value(const LagrangianInjection &, const LagrangianSubMesh &) const
Return the value for an instantaneous injection.
virtual tmp< LagrangianSubField< Type > > sourceValue(const LagrangianSource &, const LagrangianSubMesh &) const
Return the source value.
virtual tmp< LagrangianSubScalarField > internalCoeff(const LagrangianSource &, const LagrangianSubMesh &) const
Return the internal coefficient.
Generic dimensioned Type class.
Traits class for primitives.
Definition: pTraits.H:53
A class for managing temporary objects.
Definition: tmp.H:55
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
const dimensionSet dimless
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.