MRFPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2022 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 Class
25  Foam::MRFnoSlipFvPatchVectorField
26 
27 Description
28 
29 See also
30  Foam::MRFZone
31 
32 SourceFiles
33  MRFPatchField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef MRFPatchField_H
38 #define MRFPatchField_H
39 
40 #include "fvPatchFields.H"
41 #include "MRFZone.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class MRFPatchField Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class MRFPatchField
53 {
54  // Private data
55 
56  word MRFZoneName_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct null
64  MRFPatchField();
65 
66  //- Construct from dictionary
67  MRFPatchField(const dictionary&);
68 
69 
70  // Member Functions
71 
72  const MRFZone& MRFzone(const objectRegistry& obr) const;
73 
74  void makeAbsolute(fvPatchField<vector>& Up) const;
75 
76  void makeRelative(fvPatchField<vector>& Up) const;
77 
78  void write(Ostream&) const;
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
void makeRelative(fvPatchField< vector > &Up) const
Definition: MRFPatchField.C:93
void makeAbsolute(fvPatchField< vector > &Up) const
Definition: MRFPatchField.C:87
void write(Ostream &) const
Definition: MRFPatchField.C:99
MRFPatchField()
Construct null.
Definition: MRFPatchField.C:31
const MRFZone & MRFzone(const objectRegistry &obr) const
Definition: MRFPatchField.C:44
MRF zone definition based on cell zone and parameters obtained from a control dictionary constructed ...
Definition: MRFZone.H:56
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:87
Registry of regIOobjects.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.