fvOptionI.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 | Copyright (C) 2011-2015 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
28 inline const Foam::word& Foam::fv::option::name() const
29 {
30  return name_;
31 }
32 
33 
34 inline const Foam::fvMesh& Foam::fv::option::mesh() const
35 {
36  return mesh_;
37 }
38 
39 
41 {
42  return coeffs_;
43 }
44 
45 
46 inline bool Foam::fv::option::active() const
47 {
48  return active_;
49 }
50 
51 
52 inline void Foam::fv::option::setApplied(const label fieldI)
53 {
54  applied_[fieldI] = true;
55 }
56 
57 
59 {
60  return active_;
61 }
62 
63 
64 // ************************************************************************* //
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: fvOptionI.H:34
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void setApplied(const label fieldI)
Set the applied flag to true for field index fieldI.
Definition: fvOptionI.H:52
dictionary coeffs_
Dictionary containing source coefficients.
Definition: fvOption.H:84
const word & name() const
Return const access to the source name.
Definition: fvOptionI.H:28
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const word name_
Source name.
Definition: fvOption.H:72
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none.
Definition: Switch.H:60
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
List< bool > applied_
Applied flag list - corresponds to each fieldNames_ entry.
Definition: fvOption.H:93
const fvMesh & mesh_
Reference to the mesh database.
Definition: fvOption.H:78
const dictionary & coeffs() const
Return dictionary.
Definition: fvOptionI.H:40
bool active() const
Return const access to the source active flag.
Definition: fvOptionI.H:46
Switch active_
Source active flag.
Definition: fvOption.H:87