/usr/include/freefoam/lagrangianIntermediate/phaseProperties.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::phaseProperties
Description
Helper class to manage multi-component phase properties
SourceFiles
phaseProperties.C
phasePropertiesIO.C
\*---------------------------------------------------------------------------*/
#ifndef phaseProperties_H
#define phaseProperties_H
#include <OpenFOAM/NamedEnum.H>
#include <OpenFOAM/Tuple2.H>
#include <OpenFOAM/PtrList.H>
#include <finiteVolume/volFields.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class phaseProperties Declaration
\*---------------------------------------------------------------------------*/
class phaseProperties
{
public:
// Public data
//- Phase type enumeration
enum phaseType
{
GAS,
LIQUID,
SOLID,
UNKNOWN
};
//- Corresponding word representations for phase type enumerations
static const NamedEnum<phaseType, 4> phaseTypeNames_;
private:
// Private data
//- Phase type
phaseType phase_;
//- State label (s), (l), (g) etc.
word stateLabel_;
//- List of component names
List<word> names_;
//- List of component mass fractions
scalarField Y_;
//- Global ids
labelList globalIds_;
//- Map to carrier global id
labelList globalCarrierIds_;
// Private member functions
//- Set global ids
void setGlobalIds(const wordList& globalNames);
//- Set global carrier ids - attempts to map component names to global
// carrier species
void setGlobalCarrierIds(const wordList& carrierNames);
//- Check the total mass fraction
void checkTotalMassFraction() const;
//- Set the state label
word phaseToStateLabel(const phaseType pt) const;
public:
// Constructors
//- Null constructor
phaseProperties();
//- Construct from Istream
phaseProperties(Istream&);
//- Construct as copy
phaseProperties(const phaseProperties&);
//- Destructor
~phaseProperties();
// Public member functions
//- Initialise the global ids
void initialiseGlobalIds
(
const wordList& gasNames,
const wordList& liquidNames,
const wordList& solidNames
);
// Access
//- Return const access to the phase type
phaseType phase() const;
//- Return const access to the phase state label
const word& stateLabel() const;
//- Return word representation of the phase type
word phaseTypeName() const;
//- Return the list of component names
const List<word>& names() const;
//- Return const access to a component name
const word& name(const label cmptI) const;
//- Return const access to all component mass fractions
const scalarField& Y() const;
//- Return non-const access to a component mass fraction
scalar& Y(const label cmptI);
//- Return const access to the global ids
const labelList& globalIds() const;
//- Return const access to the map to the carrier global ids
const labelList& globalCarrierIds() const;
//- Return the global id of a component in the local list by name
// Returns -1 if not found
label globalId(const word& cmptName) const;
//- Return the id of a component in the local list by name
// Returns -1 if not found
label id(const word& cmptName) const;
// IOstream Operators
friend Istream& operator>>(Istream&, phaseProperties&);
friend Ostream& operator<<(Ostream&, const phaseProperties&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|