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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30
31inline const Foam::word& Foam::fv::option::name() const noexcept
32{
33 return name_;
34}
35
36
38{
39 return mesh_;
40}
41
42
44{
45 return coeffs_;
46}
47
48
50{
51 return active_;
52}
53
54
55inline bool Foam::fv::option::active(const bool on) noexcept
56{
57 bool old(active_);
58 active_ = on;
59 return old;
60}
61
62
63inline void Foam::fv::option::setApplied(const label fieldi)
64{
65 applied_[fieldi] = true;
66}
67
68
69// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
const word & name() const noexcept
Return const access to the source name.
Definition: fvOptionI.H:31
const dictionary & coeffs() const noexcept
Return dictionary.
Definition: fvOptionI.H:43
void setApplied(const label fieldi)
Set the applied flag to true for field index fieldi.
Definition: fvOptionI.H:63
bool active() const noexcept
True if source is active.
Definition: fvOptionI.H:49
const fvMesh & mesh() const noexcept
Return const access to the mesh database.
Definition: fvOptionI.H:37
const word name_
Source name.
Definition: fvOption.H:133
A class for handling words, derived from Foam::string.
Definition: word.H:68
const direction noexcept
Definition: Scalar.H:223