totalFlowRateAdvectiveDiffusiveFvPatchScalarField.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-2019 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::totalFlowRateAdvectiveDiffusiveFvPatchScalarField
26 
27 Description
28  This BC is used for species inlets. The diffusion and advection fluxes are
29  considered to calculate the inlet value for the species
30  The massFluxFraction sets the fraction of the flux of each particular
31  species.
32 
33 SourceFiles
34  totalFlowRateAdvectiveDiffusiveFvPatchScalarField.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef totalFlowRateAdvectiveDiffusiveFvPatchScalarField_H
39 #define totalFlowRateAdvectiveDiffusiveFvPatchScalarField_H
40 
41 #include "mixedFvPatchField.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class totalFlowRateAdvectiveDiffusiveFvPatchScalarField Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public mixedFvPatchField<scalar>
55 {
56  // Private Data
57 
58  //- Name of the flux transporting the field
59  word phiName_;
60 
61  //- Name of the density field used to normalise the mass flux
62  // if necessary
63  word rhoName_;
64 
65  //- Mass flux fraction
66  scalar massFluxFraction_;
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("totalFlowRateAdvectiveDiffusive");
72 
73 
74  // Constructors
75 
76  //- Construct from patch and internal field
78  (
79  const fvPatch&,
81  );
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const fvPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given
92  // totalFlowRateAdvectiveDiffusiveFvPatchScalarField
93  // onto a new patch
95  (
97  const fvPatch&,
99  const fvPatchFieldMapper&
100  );
101 
102  //- Copy constructor
104  (
106  );
107 
108  //- Construct and return a clone
109  virtual tmp<fvPatchField<scalar>> clone() const
110  {
112  (
113  new
115  );
116  }
117 
118  //- Copy constructor setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
132  (
133  new
135  (
136  *this,
137  iF
138  )
139  );
140  }
141 
142 
143  // Member Functions
144 
145  // Mapping functions
146 
147  //- Map (and resize as needed) from self given a mapping object
148  // Used to update fields following mesh topology change
149  virtual void autoMap(const fvPatchFieldMapper&);
150 
151  //- Reverse map the given fvPatchField onto this fvPatchField
152  // Used to reconstruct fields
153  virtual void rmap(const fvPatchScalarField&, const labelList&);
154 
155 
156  // Evaluation functions
157 
158  //- Update the coefficients associated with the patch field
159  virtual void updateCoeffs();
160 
161 
162  //- Write
163  virtual void write(Ostream&) const;
164 };
165 
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #endif
174 
175 // ************************************************************************* //
This BC is used for species inlets. The diffusion and advection fluxes are considered to calculate th...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a base class for &#39;mixed&#39; type boundary conditions, i.e. conditions that mix fixed value and patch-normal gradient conditions.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual tmp< fvPatchField< scalar > > clone() const
Construct and return a clone.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("totalFlowRateAdvectiveDiffusive")
Runtime type information.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A class for managing temporary objects.
Definition: PtrList.H:53
totalFlowRateAdvectiveDiffusiveFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.