ConstantField.C 7.09 KB
Newer Older
Mattijs Janssens's avatar
Mattijs Janssens committed
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
Mattijs Janssens's avatar
Mattijs Janssens committed
6
     \\/     M anipulation  |
OpenFOAM bot's avatar
OpenFOAM bot committed
7
-------------------------------------------------------------------------------
8
    Copyright (C) 2018-2020 OpenCFD Ltd.
Mattijs Janssens's avatar
Mattijs Janssens committed
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
-------------------------------------------------------------------------------
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/>.

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

#include "ConstantField.H"

// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

template<class Type>
Foam::PatchFunction1Types::ConstantField<Type>::ConstantField
(
    const polyPatch& pp,
    const word& entryName,
37
38
39
    const bool isUniform,
    const Type& uniformValue,
    const Field<Type>& nonUniformValue,
Mattijs Janssens's avatar
Mattijs Janssens committed
40
41
42
43
44
    const dictionary& dict,
    const bool faceValues
)
:
    PatchFunction1<Type>(pp, entryName, dict, faceValues),
45
46
47
    isUniform_(isUniform),
    uniformValue_(uniformValue),
    value_(nonUniformValue)
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
    if (faceValues && nonUniformValue.size() != pp.size())
    {
        FatalIOErrorInFunction(dict)
            << "Supplied field size " << nonUniformValue.size()
            << " is not equal to the number of faces " << pp.size()
            << " of patch " << pp.name() << exit(FatalIOError);
    }
    else if (!faceValues && nonUniformValue.size() != pp.nPoints())
    {
        FatalIOErrorInFunction(dict)
            << "Supplied field size " << nonUniformValue.size()
            << " is not equal to the number of points " << pp.nPoints()
            << " of patch " << pp.name() << exit(FatalIOError);
    }
}
Mattijs Janssens's avatar
Mattijs Janssens committed
64
65


66
67
68
69
70
template<class Type>
Foam::Field<Type> Foam::PatchFunction1Types::ConstantField<Type>::getValue
(
    const word& keyword,
    const dictionary& dict,
71
72
73
    const label len,
    bool& isUniform,
    Type& uniformValue
74
75
)
{
76
77
78
    isUniform = true;
    uniformValue = Zero;

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
    Field<Type> fld;

    if (len)
    {
        ITstream& is = dict.lookup(keyword);

        // Read first token
        token firstToken(is);

        if (firstToken.isWord())
        {
            if
            (
                firstToken.wordToken() == "uniform"
             || firstToken.wordToken() == "constant"
            )
            {
96
                is >> uniformValue;
97
                fld.setSize(len);
98
                fld = uniformValue;
99
            }
100
101
102
103
            else if (firstToken.wordToken() == "nonuniform")
            {
                List<Type>& list = fld;
                is >> list;
104
105
                isUniform = false;

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
                label currentSize = fld.size();
                if (currentSize != len)
                {
                    if
                    (
                        len < currentSize
                     && FieldBase::allowConstructFromLargerSize
                    )
                    {
                        #ifdef FULLDEBUG
                        IOWarningInFunction(dict)
                            << "Sizes do not match. "
                            << "Re-sizing " << currentSize
                            << " entries to " << len
                            << endl;
                        #endif

                        // Resize the data
                        fld.setSize(len);
                    }
                    else
                    {
                        FatalIOErrorInFunction(dict)
                            << "size " << fld.size()
                            << " is not equal to the given value of " << len
                            << exit(FatalIOError);
                    }
                }
            }
135
136
            else
            {
137
                isUniform = false;
138
                FatalIOErrorInFunction(dict)
139
                    << "Expected keyword 'uniform', 'nonuniform' or 'constant'"
140
                    << ", found " << firstToken.wordToken()
141
142
143
144
145
146
                    << exit(FatalIOError);
            }
        }
        else
        {
            is.putBack(firstToken);
147
148
149
            is >> uniformValue;
            fld.setSize(len);
            fld = uniformValue;
150
151
        }
    }
152

153
154
155
156
    return fld;
}


Mattijs Janssens's avatar
Mattijs Janssens committed
157
158
159
160
template<class Type>
Foam::PatchFunction1Types::ConstantField<Type>::ConstantField
(
    const polyPatch& pp,
161
    const word& type,
Mattijs Janssens's avatar
Mattijs Janssens committed
162
163
164
165
166
167
    const word& entryName,
    const dictionary& dict,
    const bool faceValues
)
:
    PatchFunction1<Type>(pp, entryName, dict, faceValues),
168
169
170
171
172
173
174
175
176
177
178
    value_
    (
        getValue
        (
            entryName,
            dict,
            (faceValues ? pp.size() : pp.nPoints()),
            isUniform_,
            uniformValue_
        )
    )
Mattijs Janssens's avatar
Mattijs Janssens committed
179
180
181
182
183
184
185
186
187
188
{}


template<class Type>
Foam::PatchFunction1Types::ConstantField<Type>::ConstantField
(
    const ConstantField<Type>& cnst
)
:
    PatchFunction1<Type>(cnst),
189
190
    isUniform_(cnst.isUniform_),
    uniformValue_(cnst.uniformValue_),
Mattijs Janssens's avatar
Mattijs Janssens committed
191
192
193
194
195
196
197
198
199
200
201
202
    value_(cnst.value_)
{}


template<class Type>
Foam::PatchFunction1Types::ConstantField<Type>::ConstantField
(
    const ConstantField<Type>& cnst,
    const polyPatch& pp
)
:
    PatchFunction1<Type>(cnst, pp),
203
204
    isUniform_(cnst.isUniform_),
    uniformValue_(cnst.uniformValue_),
Mattijs Janssens's avatar
Mattijs Janssens committed
205
    value_(cnst.value_)
206
207
{
    // If different sizes do what?
208
209
210
211
212
213
    value_.setSize
    (
        this->faceValues_
      ? this->patch_.size()
      : this->patch_.nPoints()
    );
214
215
216
217
218
    if (isUniform_)
    {
        value_ = uniformValue_;
    }
}
Mattijs Janssens's avatar
Mattijs Janssens committed
219
220
221
222
223
224
225
226
227
228
229


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

template<class Type>
void Foam::PatchFunction1Types::ConstantField<Type>::autoMap
(
    const FieldMapper& mapper
)
{
    value_.autoMap(mapper);
230
231
232
233
234
235

    // If originating from single value override just to make sure
    if (isUniform_)
    {
        value_ = uniformValue_;
    }
Mattijs Janssens's avatar
Mattijs Janssens committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
}


template<class Type>
void Foam::PatchFunction1Types::ConstantField<Type>::rmap
(
    const PatchFunction1<Type>& pf1,
    const labelList& addr
)
{
    const auto& cst = refCast<const ConstantField<Type>>(pf1);
    value_.rmap(cst.value_, addr);
}


template<class Type>
void Foam::PatchFunction1Types::ConstantField<Type>::writeData
(
    Ostream& os
) const
{
    PatchFunction1<Type>::writeData(os);
258
259
260
261

    if (isUniform_)
    {
        os.writeKeyword(this->name_)
262
            << word("constant") << token::SPACE << uniformValue_
263
264
265
266
267
268
            << token::END_STATEMENT << nl;
    }
    else
    {
        value_.writeEntry(this->name_, os);
    }
Mattijs Janssens's avatar
Mattijs Janssens committed
269
270
271
272
}


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