porosityModelI.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) 2012-2018 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 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
29 
31 {
32  return *csysPtr_;
33 }
34 
35 
36 inline Foam::label Foam::porosityModel::fieldIndex(const label i) const
37 {
38  return (csysPtr_->uniform() ? 0 : i);
39 }
40 
41 
42 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
43 
45 {
46  return name_;
47 }
48 
49 
50 inline bool Foam::porosityModel::active() const
51 {
52  return active_;
53 }
54 
55 
57 {
58  return dict_;
59 }
60 
61 
63 {
64  return cellZoneIDs_;
65 }
66 
67 
68 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::porosityModel::cellZoneIDs
const labelList & cellZoneIDs() const
Return const access to the cell zone IDs.
Definition: porosityModelI.H:62
Foam::porosityModel::name
const word & name() const
Return const access to the porosity model name.
Definition: porosityModelI.H:44
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::List< label >
Foam::porosityModel::fieldIndex
label fieldIndex(const label index) const
Return label index.
Definition: porosityModelI.H:36
Foam::porosityModel::active
bool active() const
Return const access to the porosity active flag.
Definition: porosityModelI.H:50
Foam::porosityModel::csys
const coordinateSystem & csys() const
Local coordinate system.
Definition: porosityModelI.H:30
Foam::porosityModel::csysPtr_
autoPtr< coordinateSystem > csysPtr_
Local coordinate system.
Definition: porosityModel.H:96
Foam::porosityModel::dict
const dictionary & dict() const
Return dictionary used for model construction.
Definition: porosityModelI.H:56
Foam::coordinateSystem
Base class for coordinate system specification, the default coordinate system type is cartesian .
Definition: coordinateSystem.H:132