OpenFOAM logo
Open Source CFD Toolkit

IOobject.H File Reference


Detailed Description

View IOobject.H
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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
IOobject defines the attributes of an object for which implicit
objectRegistry management is supported, and provides the infrastructure for
performing stream I/O. An IOobject is constructed with an object name, a
class name, an instance path, a reference to a objectRegistry, and
parameters determining its storage status.

Read options define what is done on object construction & explicit reads:

    MUST_READ
        Object must be read from Istream on construction.
        Error if Istream does not exist or can't be read.

    READ_IF_PRESENT
        Read object from Istream if Istream exists, otherwise don't.
        Error only if Istream exists but can't be read.

    NO_READ
        Don't read

Write options define what is done on object destruction & explicit writes:

    AUTO_WRITE
        Object is written automatically when requested to by the
        objectRegistry.

    NO_WRITE
        No automatic write on destruction but can be written explicitly

Source files

Definition in file IOobject.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  IOobject

For further information go to www.openfoam.org