porosityModelList.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) 2012-2018 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::porosityModelList
26 
27 Description
28  List container for porosity models
29 
30 SourceFiles
31  porosityModelList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef porosityModelList_H
36 #define porosityModelList_H
37 
38 #include "fvMesh.H"
39 #include "dictionary.H"
40 #include "fvMatricesFwd.H"
41 #include "porosityModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of friend functions and operators
49 class porosityModelList;
50 Ostream& operator<<(Ostream& os, const porosityModelList& models);
51 
52 /*---------------------------------------------------------------------------*\
53  Class porosityModelList Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public PtrList<porosityModel>
59 {
60 private:
61 
62  // Private Member Functions
63 
64  //- Disallow default bitwise copy construct
66 
67  //- Disallow default bitwise assignment
68  void operator=(const porosityModelList&);
69 
70 
71 protected:
72 
73  // Protected data
74 
75  //- Reference to the mesh database
76  const fvMesh& mesh_;
77 
78 
79 public:
80 
81  //- Constructor
83 
84  //- Destructor
86 
87 
88  // Member Functions
89 
90  //- Return active status
91  bool active(const bool active = false) const;
92 
93  //- Reset the source list
94  void reset(const dictionary& dict);
95 
96  //- Add resistance
98 
99  //- Add resistance
100  void addResistance
101  (
103  const volScalarField& rho,
104  const volScalarField& mu
105  );
106 
107  //- Add resistance
108  void addResistance
109  (
110  const fvVectorMatrix& UEqn,
111  volTensorField& AU,
112  bool correctAUprocBC = true
113  );
114 
115 
116  // I-O
117 
118  //- Read dictionary
119  bool read(const dictionary& dict);
120 
121  //- Write data to Ostream
122  bool writeData(Ostream& os) const;
123 
124  //- Ostream operator
125  friend Ostream& operator<<
126  (
127  Ostream& os,
128  const porosityModelList& models
129  );
130 };
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
bool writeData(Ostream &os) const
Write data to Ostream.
dictionary dict
bool read(const dictionary &dict)
Read dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh_
Reference to the mesh database.
~porosityModelList()
Destructor.
dynamicFvMesh & mesh
void reset(const dictionary &dict)
Reset the source list.
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:72
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
const dimensionedScalar mu
Atomic mass unit.
Forward declarations of fvMatrix specializations.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:63
fvVectorMatrix & UEqn
Definition: UEqn.H:13
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Ostream & operator<<(Ostream &, const ensightPart &)
List container for porosity models.
bool active(const bool active=false) const
Return active status.
void addResistance(fvVectorMatrix &UEqn)
Add resistance.
Namespace for OpenFOAM.