MRFZoneI.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 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
29inline const Foam::word& Foam::MRFZone::name() const
30{
31 return name_;
32}
33
34
35inline bool Foam::MRFZone::active() const
36{
37 return active_;
38}
39
40
42{
43 return origin_;
44}
45
46
47inline const Foam::vector& Foam::MRFZone::axis() const
48{
49 return axis_;
50}
51
52
53// ************************************************************************* //
const vector & origin() const
Return const access to the MRF origin.
Definition: MRFZoneI.H:41
const vector & axis() const
Return const access to the MRF axis.
Definition: MRFZoneI.H:47
bool active() const
Return const access to the MRF active flag.
Definition: MRFZoneI.H:35
const word & name() const
Return const access to the MRF region name.
Definition: MRFZoneI.H:29
A class for handling words, derived from Foam::string.
Definition: word.H:68