wallShearStressWriter.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::wallShearStressWriter
23 
24 Description
25  Write wallShearStress field
26 
27 SourceFiles
28  wallShearStress.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef wallShearStressWriter_H
33 #define wallShearStressWriter_H
34 
35 #include "derivedFieldWriter.H"
36 #include "volFieldsFwd.H"
37 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43  class dictionary;
44 
45 
46  /*---------------------------------------------------------------------------*\
47  Class wallShearStressWriter Declaration
48  \*---------------------------------------------------------------------------*/
49 
51  {
52  // Private data
53 
54  //- Name of velocity field
55  word UName_;
56 
57  //- Name of density field (optional)
58  word rhoName_;
59 
60  //- Reference density needed for incompressible calculations
61  scalar rhoRef_;
62 
63  // Private methods
64 
65  //- Return the effective viscous stress (laminar + turbulent).
67  bool & foundField) const;
68 
69  //- Return rho field if it exists or rhoRef_ for incompressible rho
71 
72  public:
73  //- Runtime type information
74  TypeName("wallShearStressWriter");
75 
76  //- Field file name.
77  static const word FIELD_NAME;
78 
79  // Constructors
80 
82 
83  // Member Functions
84 
85  //- Write derived field.
86  virtual void write(const objectRegistry& obr);
87  };
88 
89  // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
volFieldsFwd.H
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::wallShearStressWriter::rhoName_
word rhoName_
Name of density field (optional)
Definition: wallShearStressWriter.H:57
Foam::wallShearStressWriter::TypeName
TypeName("wallShearStressWriter")
Runtime type information.
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:50
Foam::derivedFieldWriter
Basis for writers used in derivedFields e.g., wallShearStressWriter.
Definition: derivedFieldWriter.H:49
Foam::wallShearStressWriter::write
virtual void write(const objectRegistry &obr)
Write derived field.
Definition: wallShearStressWriter.C:116
Foam::wallShearStressWriter::rhoRef_
scalar rhoRef_
Reference density needed for incompressible calculations.
Definition: wallShearStressWriter.H:60
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::wallShearStressWriter
Write wallShearStress field.
Definition: wallShearStressWriter.H:49
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::wallShearStressWriter::wallShearStressWriter
wallShearStressWriter(const dictionary &dict)
Definition: wallShearStressWriter.C:101
Foam::wallShearStressWriter::UName_
word UName_
Name of velocity field.
Definition: wallShearStressWriter.H:54
Foam::wallShearStressWriter::devRhoReff
tmp< volSymmTensorField > devRhoReff(const objectRegistry &obr, bool &foundField) const
Return the effective viscous stress (laminar + turbulent).
Definition: wallShearStressWriter.C:73
Foam::wallShearStressWriter::FIELD_NAME
static const word FIELD_NAME
Field file name.
Definition: wallShearStressWriter.H:76
Foam::wallShearStressWriter::rho
tmp< Foam::volScalarField > rho(const objectRegistry &obr) const
Return rho field if it exists or rhoRef_ for incompressible rho.
Definition: wallShearStressWriter.C:44