TimeActivatedExplicitSourceList.H 4.56 KB
Newer Older
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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2010-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 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

Class
    Foam::TimeActivatedExplicitSourceList

Description
29
    List of time activeted explict sources
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

SourceFiles
    TimeActivatedExplicitSourceList.C

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

#ifndef TimeActivatedExplicitSourceList_H
#define TimeActivatedExplicitSourceList_H

#include "IOPtrList.H"
#include "TimeActivatedExplicitSource.H"

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

namespace Foam
{

// Forward declaration of classes
class fvMesh;

template<class Type>
class TimeActivatedExplicitSource;

template<class Type>
class TimeActivatedExplicitSourceList;

// Forward declaration of friend functions

template<class Type>
Ostream& operator<<
(
    Ostream&,
    const TimeActivatedExplicitSourceList<Type>&
);

/*---------------------------------------------------------------------------*\
             Class TimeActivatedExplicitSourceList Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class TimeActivatedExplicitSourceList
:
    public IOPtrList<TimeActivatedExplicitSource<Type> >
{
private:

    // Private data

        //- Name of source properties list
        word name_;

        //- Reference to the mesh database
        const fvMesh& mesh_;

        //- Dimensions of source properties
        dimensionSet dimensions_;

87
        //- List of field names the source is working on
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
172
        wordList fieldNames_;


    // Private member functions

        //- Disallow default bitwise copy construct
        TimeActivatedExplicitSourceList
        (
            const TimeActivatedExplicitSourceList<Type>&
        );

        //- Disallow default bitwise assignment
        void operator=(const TimeActivatedExplicitSourceList<Type>&);


public:

    // Constructors

        //- Construct from components with list of field names
        TimeActivatedExplicitSourceList
        (
            const word& name,
            const fvMesh& mesh,
            const dimensionSet& dimensions,
            const wordList& fieldNames
        );

        //- Construct from components with single field name
        TimeActivatedExplicitSourceList
        (
            const word& name,
            const fvMesh& mesh,
            const dimensionSet& dimensions,
            const word& fieldName
        );


    // Member Functions

        // Evaluation

            //- Return the source for field, fieldI
            tmp<DimensionedField<Type, volMesh> > Su
            (
                const label fieldI = 0
            );

            //- Return the total source for all fields
            tmp<DimensionedField<Type, volMesh> > SuTot();



        // I-O

            //- Read data from Istream
            bool readData(Istream& is);

            //- Write data to Istream
            bool writeData(Ostream& os) const;

            //- Ostream operator
            friend Ostream& operator<< <Type>
            (
                Ostream& os,
                const TimeActivatedExplicitSourceList& sp
            );
};


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

} // End namespace Foam

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

#ifdef NoRepository
#   include "TimeActivatedExplicitSourceList.C"
#endif

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

#endif

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