IOField.H 3.4 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
OpenFOAM bot's avatar
OpenFOAM bot committed
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8 9
    Copyright (C) 2011-2017 OpenFOAM Foundation
    Copyright (C) 2018 OpenCFD Ltd.
10 11 12 13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14 15 16 17
    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.
18 19 20 21 22 23 24

    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
25
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
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

Class
    Foam::IOField

Description
    A primitive field of type \<T\> with automated input and output.

SourceFiles
    IOField.C

\*---------------------------------------------------------------------------*/

#ifndef IOField_H
#define IOField_H

#include "regIOobject.H"
#include "Field.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class IOField Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class IOField
:
    public regIOobject,
    public Field<Type>
{
public:

    TypeName("Field");


    // Constructors

66 67 68
        //- Default copy construct
        IOField(const IOField&) = default;

69
        //- Construct from IOobject
70
        explicit IOField(const IOobject& io);
71

72
        //- Construct from IOobject; does local processor require reading?
73
        IOField(const IOobject& io, const bool valid);
74

Mark Olesen's avatar
Mark Olesen committed
75
        //- Construct from IOobject and size (does not set values)
76 77 78 79
        IOField(const IOobject& io, const label size);

        //- Construct from IOobject and a List/Field content
        IOField(const IOobject& io, const UList<Type>& content);
Mark Olesen's avatar
Mark Olesen committed
80

81 82
        //- Construct by transferring the Field content
        IOField(const IOobject& io, Field<Type>&& content);
83

84 85
        //- Construct by copying/moving tmp content
        IOField(const IOobject& io, const tmp<Field<Type>>& tfld);
86 87


88
    //- Destructor
89
    virtual ~IOField() = default;
90 91


92
    // Member Functions
93

94
        bool writeData(Ostream& os) const;
95 96


97
    // Member Operators
98

99 100
        //- Copy assignment of entries
        void operator=(const IOField<Type>& rhs);
101

102 103
        //- Copy or move assignment of entries
        using Field<Type>::operator=;
104 105 106 107 108 109 110 111 112 113
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
114
    #include "IOField.C"
115 116 117 118 119 120 121
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //