yPlusWriter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  Copyright : (C) 2011 Symscape
3  Website : www.symscape.com
4 -------------------------------------------------------------------------------
5 License
6  This file is part of OpenFOAM.
7 
8  OpenFOAM is free software: you can redistribute it and/or modify it
9  under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
14  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16  for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
20 
21 Class
22  Foam::yPlusWriter
23 
24 Description
25  Write yPlus field
26 
27 SourceFiles
28  yPlus.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef yPlusWriter_H
33 #define yPlusWriter_H
34 
35 #include "derivedFieldWriter.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41  class dictionary;
42 
43 
44  /*---------------------------------------------------------------------------*\
45  Class yPlusWriter Declaration
46  \*---------------------------------------------------------------------------*/
47 
48  class yPlusWriter : public derivedFieldWriter
49  {
50  public:
51  //- Runtime type information
52  TypeName("yPlusWriter");
53 
54  //- Field file name.
55  static const word FIELD_NAME;
56 
57  // Constructors
58 
59  yPlusWriter(const dictionary& dict);
60 
61  // Member Functions
62 
63  //- Write derived field.
64  virtual void write(const objectRegistry& obr);
65  };
66 
67  // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68 
69 } // End namespace Foam
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 #endif
74 
75 // ************************************************************************* //
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::yPlusWriter::TypeName
TypeName("yPlusWriter")
Runtime type information.
Foam::yPlusWriter::FIELD_NAME
static const word FIELD_NAME
Field file name.
Definition: yPlusWriter.H:54
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:50
Foam::yPlusWriter
Write yPlus field.
Definition: yPlusWriter.H:47
Foam::derivedFieldWriter
Basis for writers used in derivedFields e.g., wallShearStressWriter.
Definition: derivedFieldWriter.H:49
Foam::yPlusWriter::write
virtual void write(const objectRegistry &obr)
Write derived field.
Definition: yPlusWriter.C:51
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
derivedFieldWriter.H
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::yPlusWriter::yPlusWriter
yPlusWriter(const dictionary &dict)
Definition: yPlusWriter.C:43