/usr/include/freefoam/OpenFOAM/functionObject.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObject
Description
Abstract base-class for Time/database function objects.
See Also
Foam::OutputFilterFunctionObject
SourceFiles
functionObject.C
\*---------------------------------------------------------------------------*/
#ifndef functionObject_H
#define functionObject_H
#include <OpenFOAM/typeInfo.H>
#include <OpenFOAM/autoPtr.H>
#include <OpenFOAM/runTimeSelectionTables.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class Time;
/*---------------------------------------------------------------------------*\
Class functionObject Declaration
\*---------------------------------------------------------------------------*/
class functionObject
{
// Private data
//- Name
const word name_;
// Private Member Functions
//- Disallow default bitwise copy construct
functionObject(const functionObject&);
//- Disallow default bitwise assignment
void operator=(const functionObject&);
public:
//- Runtime type information
virtual const word& type() const = 0;
static int debug;
// Declare run-time constructor selection tables
declareRunTimeSelectionTable
(
autoPtr,
functionObject,
dictionary,
(const word& name, const Time& t, const dictionary& dict),
(name, t, dict)
);
// Constructors
//- Construct from components
functionObject(const word& name);
//- Return clone
autoPtr<functionObject> clone() const
{
notImplemented("functionObject::clone() const");
return autoPtr<functionObject>(NULL);
}
//- Return a pointer to a new functionObject created on freestore
// from Istream
class iNew
{
const Time& time_;
public:
iNew(const Time& t)
:
time_(t)
{}
autoPtr<functionObject> operator()
(
const word& name,
Istream& is
) const;
};
// Selectors
//- Select from dictionary, based on its "type" entry
static autoPtr<functionObject> New
(
const word& name,
const Time&,
const dictionary&
);
// Destructor
virtual ~functionObject();
// Member Functions
//- Name
virtual const word& name() const;
//- Called at the start of the time-loop
virtual bool start() = 0;
//- Called at each ++ or += of the time-loop
virtual bool execute() = 0;
//- Called when Time::run() determines that the time-loop exits.
// By default it simply calls execute().
virtual bool end();
//- Read and set the function object if its data have changed
virtual bool read(const dictionary&) = 0;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|