noPyrolysis.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::regionModels::pyrolysisModels::noPyrolysis
28 
29 Description
30  Dummy surface pyrolysis model for 'none'
31 
32 SourceFiles
33  noPyrolysis.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef noPyrolysis_H
38 #define noPyrolysis_H
39 
40 #include "pyrolysisModel.H"
41 #include "volFieldsFwd.H"
43 #include "radiationModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace regionModels
50 {
51 namespace pyrolysisModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class noPyrolysis Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class noPyrolysis
59 :
60  public pyrolysisModel
61 {
62 private:
63 
64  // Private member functions
65 
66  //- No copy construct
67  noPyrolysis(const noPyrolysis&) = delete;
68 
69  //- No copy assignment
70  void operator=(const noPyrolysis&) = delete;
71 
72 
73 protected:
74 
75  // Protected member functions
76 
77  //- Read control parameters from dictionary
78  virtual bool read();
79 
80  //- Read control parameters from dictionary
81  virtual bool read(const dictionary& dict);
82 
83  //- Reset solidChemistryModel and solidThermo pointers
85 
86  //- Reference to solid thermo
88 
89  //- Reference to the solid chemistry model
91 
92  //- Pointer to radiation model
94 
95 
96 public:
97 
98  //- Runtime type information
99  TypeName("none");
100 
101 
102  // Constructors
103 
104  //- Construct from type name and mesh
106  (
107  const word& modelType,
108  const fvMesh& mesh,
109  const word& regionType
110  );
111 
112  //- Construct from type name and mesh and dict
114  (
115  const word& modelType,
116  const fvMesh& mesh,
117  const dictionary& dict,
118  const word& regionType
119  );
120 
121 
122  //- Destructor
123  virtual ~noPyrolysis();
124 
125 
126  // Member Functions
127 
128  // Fields
129 
130  //- Return density [kg/m3]
131  virtual const volScalarField& rho() const;
132 
133  //- Return const temperature [K]
134  virtual const volScalarField& T() const;
135 
136  //- Return specific heat capacity [J/kg/K]
137  virtual const tmp<volScalarField> Cp() const;
138 
139  //- Return the region absorptivity [1/m]
140  virtual tmp<volScalarField> kappaRad() const;
141 
142  //- Return the region thermal conductivity [W/m/k]
143  virtual tmp<volScalarField> kappa() const;
144 
145  //- Return the total gas mass flux to primary region [kg/m2/s]
146  virtual const surfaceScalarField& phiGas() const;
147 
148 
149  // Evolution
150 
151  //- Pre-evolve region
152  virtual void preEvolveRegion();
153 
154  //- Evolve the pyrolysis equations
155  virtual void evolveRegion();
156 };
157 
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 } // End namespace pyrolysisModels
162 } // End namespace regionModels
163 } // End namespace Foam
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************************************************************* //
Foam::regionModels::pyrolysisModels::pyrolysisModel
Base class for pyrolysis models.
Definition: pyrolysisModel.H:61
volFieldsFwd.H
Foam::regionModels::pyrolysisModels::noPyrolysis::kappa
virtual tmp< volScalarField > kappa() const
Return the region thermal conductivity [W/m/k].
Definition: noPyrolysis.C:165
basicSolidChemistryModel.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::regionModels::pyrolysisModels::noPyrolysis
Dummy surface pyrolysis model for 'none'.
Definition: noPyrolysis.H:57
Foam::regionModels::pyrolysisModels::noPyrolysis::evolveRegion
virtual void evolveRegion()
Evolve the pyrolysis equations.
Definition: noPyrolysis.C:137
Foam::regionModels::pyrolysisModels::noPyrolysis::constructThermoChemistry
void constructThermoChemistry()
Reset solidChemistryModel and solidThermo pointers.
Definition: noPyrolysis.C:51
Foam::regionModels::pyrolysisModels::noPyrolysis::rho
virtual const volScalarField & rho() const
Return density [kg/m3].
Definition: noPyrolysis.C:141
Foam::regionModels::pyrolysisModels::noPyrolysis::T
virtual const volScalarField & T() const
Return const temperature [K].
Definition: noPyrolysis.C:147
pyrolysisModel.H
Foam::regionModels::pyrolysisModels::noPyrolysis::phiGas
virtual const surfaceScalarField & phiGas() const
Return the total gas mass flux to primary region [kg/m2/s].
Definition: noPyrolysis.C:171
Foam::regionModels::pyrolysisModels::noPyrolysis::read
virtual bool read()
Read control parameters from dictionary.
Definition: noPyrolysis.C:70
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::regionModels::pyrolysisModels::noPyrolysis::radiation_
autoPtr< radiation::radiationModel > radiation_
Pointer to radiation model.
Definition: noPyrolysis.H:92
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::regionModels::pyrolysisModels::noPyrolysis::Cp
virtual const tmp< volScalarField > Cp() const
Return specific heat capacity [J/kg/K].
Definition: noPyrolysis.C:153
Foam::regionModels::pyrolysisModels::noPyrolysis::kappaRad
virtual tmp< volScalarField > kappaRad() const
Return the region absorptivity [1/m].
Definition: noPyrolysis.C:159
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::regionModels::pyrolysisModels::noPyrolysis::preEvolveRegion
virtual void preEvolveRegion()
Pre-evolve region.
Definition: noPyrolysis.C:133
Foam::regionModels::pyrolysisModels::noPyrolysis::TypeName
TypeName("none")
Runtime type information.
Foam::regionModels::pyrolysisModels::noPyrolysis::~noPyrolysis
virtual ~noPyrolysis()
Destructor.
Definition: noPyrolysis.C:127
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::regionModels::pyrolysisModels::noPyrolysis::solidChemistry_
autoPtr< basicSolidChemistryModel > solidChemistry_
Reference to the solid chemistry model.
Definition: noPyrolysis.H:89
Foam::regionModels::pyrolysisModels::noPyrolysis::solidThermo_
autoPtr< solidReactionThermo > solidThermo_
Reference to solid thermo.
Definition: noPyrolysis.H:86
radiationModel.H