FreeStream.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) 2011-2022 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 Class
25  Foam::FreeStream
26 
27 Description
28  Inserting new particles across the faces of a all patched of type
29  "patch" for a free stream. Uniform values number density, temperature
30  and velocity sourced face-by-face from the boundaryT and boundaryU fields
31  of the cloud.
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef FreeStream_H
36 #define FreeStream_H
37 
38 #include "InflowBoundaryModel.H"
39 #include "polyMesh.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 /*---------------------------------------------------------------------------*\
46  Class FreeStream Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
50 class FreeStream
51 :
52  public InflowBoundaryModel<CloudType>
53 {
54  // Private Data
55 
56  //- The indices of patches to introduce molecules across
57  labelList patches_;
58 
59  //- The molecule types to be introduced
60  List<label> moleculeTypeIds_;
61 
62  //- The number density of the species in the inflow
63  Field<scalar> numberDensities_;
64 
65  //- A List of Lists of Fields specifying carry-over of mass flux from
66  // one timestep to the next
67  // + Outer List - one inner List for each patch
68  // + Inner List - one Field for every species to be introduced
69  // + Each field entry corresponding to a face to be injected across
70  // with a particular species
71  List<List<Field<scalar>>> particleFluxAccumulators_;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("FreeStream");
78 
79 
80  // Constructors
81 
82  //- Construct from dictionary
84  (
85  const dictionary& dict,
87  );
88 
89 
90  //- Destructor
91  virtual ~FreeStream();
92 
93 
94  // Member Functions
95 
96  // Mapping
97 
98  //- Remap the particles to the correct cells following mesh change
99  virtual void autoMap(const polyTopoChangeMap&);
100 
101  //- Introduce particles
102  virtual void inflow();
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113  #include "FreeStream.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
virtual void autoMap(const polyTopoChangeMap &)
Remap the particles to the correct cells following mesh change.
Definition: FreeStream.C:119
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Templated inflow boundary model class.
Definition: DSMCCloud.H:61
virtual void inflow()
Introduce particles.
Definition: FreeStream.C:140
FreeStream(const dictionary &dict, CloudType &cloud)
Construct from dictionary.
Definition: FreeStream.C:37
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
A cloud is a collection of lagrangian particles.
Definition: cloud.H:51
const dictionary & dict() const
Return the owner cloud dictionary.
Inserting new particles across the faces of a all patched of type "patch" for a free stream...
Definition: FreeStream.H:49
virtual ~FreeStream()
Destructor.
Definition: FreeStream.C:112
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
TypeName("FreeStream")
Runtime type information.
Namespace for OpenFOAM.