surfaceInterpolate.C
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) 2016 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 #include "surfaceInterpolate.H"
30 #include "surfaceFields.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace functionObjects
38 {
39  defineTypeNameAndDebug(surfaceInterpolate, 0);
40 
42  (
43  functionObject,
44  surfaceInterpolate,
45  dictionary
46  );
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
52 
53 Foam::functionObjects::surfaceInterpolate::surfaceInterpolate
54 (
55  const word& name,
56  const Time& runTime,
57  const dictionary& dict
58 )
59 :
61  fieldSet_()
62 {
63  read(dict);
64 }
65 
66 
67 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
68 
70 {}
71 
72 
73 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
74 
76 (
77  const dictionary& dict
78 )
79 {
81 
82  dict.readEntry("fields", fieldSet_);
83 
84  return true;
85 }
86 
87 
89 {
90  Log << type() << " " << name() << " write:" << nl;
91 
92  interpolateFields<scalar>();
93  interpolateFields<vector>();
94  interpolateFields<sphericalTensor>();
95  interpolateFields<symmTensor>();
96  interpolateFields<tensor>();
97 
98  Info<< endl;
99 
100  return true;
101 }
102 
103 
105 {
106  Log << " functionObjects::" << type() << " " << name()
107  << " writing interpolated surface fields:" << nl;
108 
109  forAll(fieldSet_, i)
110  {
111  const word& fieldName = fieldSet_[i].second();
112 
113  const regIOobject* ioptr = obr_.findObject<regIOobject>(fieldName);
114 
115  if (ioptr)
116  {
117  Log << " " << fieldName << nl;
118  ioptr->write();
119  }
120  else
121  {
123  << "Unable to find field " << fieldName
124  << " in the mesh database" << endl;
125  }
126  }
127 
128  Log << endl;
129 
130  return true;
131 }
132 
133 
134 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:73
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:337
surfaceFields.H
Foam::surfaceFields.
Foam::functionObjects::fvMeshFunctionObject
Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
Definition: fvMeshFunctionObject.H:64
Foam::functionObjects::addToRunTimeSelectionTable
addToRunTimeSelectionTable(functionObject, add, dictionary)
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:290
Foam::regIOobject::write
virtual bool write(const bool valid=true) const
Write using setting from DB.
Definition: regIOobjectWrite.C:170
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::functionObjects::surfaceInterpolate::write
virtual bool write()
Write the interpolated fields.
Definition: surfaceInterpolate.C:104
Foam::blockMeshTools::read
void read(Istream &, label &, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:33
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::functionObjects::regionFunctionObject::read
virtual bool read(const dictionary &dict)
Read optional controls.
Definition: regionFunctionObject.C:166
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::functionObjects::surfaceInterpolate::execute
virtual bool execute()
Calculate the interpolated fields.
Definition: surfaceInterpolate.C:88
Foam::functionObjects::defineTypeNameAndDebug
defineTypeNameAndDebug(fvMeshFunctionObject, 0)
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:67
Foam::functionObjects::surfaceInterpolate::read
virtual bool read(const dictionary &)
Read the controls.
Definition: surfaceInterpolate.C:76
Foam::nl
constexpr char nl
Definition: Ostream.H:372
Foam::functionObjects::surfaceInterpolate::~surfaceInterpolate
virtual ~surfaceInterpolate()
Destructor.
Definition: surfaceInterpolate.C:69
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
surfaceInterpolate.H
WarningInFunction
#define WarningInFunction
Report a warning using Foam::Warning.
Definition: messageStream.H:294
Log
#define Log
Report write to Foam::Info if the local log switch is true.
Definition: messageStream.H:332