Function1.C 3.77 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2017 OpenFOAM Foundation
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    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.
15
16
17
18
19
20
21

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

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

Henry Weller's avatar
Henry Weller committed
26
#include "Function1.H"
27
#include "Time.H"
28
29
30
31

// * * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * //

template<class Type>
Henry Weller's avatar
Henry Weller committed
32
Foam::Function1<Type>::Function1(const word& entryName)
33
:
34
    name_(entryName)
35
36
37
{}


38
template<class Type>
Henry Weller's avatar
Henry Weller committed
39
Foam::Function1<Type>::Function1(const Function1<Type>& de)
40
:
41
    tmp<Function1<Type>>::refCount(),
42
43
44
45
    name_(de.name_)
{}


46
47
48
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

template<class Type>
Henry Weller's avatar
Henry Weller committed
49
Foam::Function1<Type>::~Function1()
50
51
52
53
54
55
{}


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

template<class Type>
Henry Weller's avatar
Henry Weller committed
56
const Foam::word& Foam::Function1<Type>::name() const
57
{
58
    return name_;
59
60
61
}


62
template<class Type>
Henry Weller's avatar
Henry Weller committed
63
void Foam::Function1<Type>::convertTimeBase(const Time&)
64
{}
65
66


67
template<class Type>
Henry Weller's avatar
Henry Weller committed
68
Type Foam::Function1<Type>::value(const scalar x) const
69
{
70
    NotImplemented;
71

72
    return Zero;
73
74
75
}


76
template<class Type>
Henry Weller's avatar
Henry Weller committed
77
Type Foam::Function1<Type>::integrate(const scalar x1, const scalar x2) const
78
{
79
    NotImplemented;
80

81
    return Zero;
82
83
84
}


85
86
87
template<class Function1Type>
Foam::tmp<Foam::Field<typename Function1Type::returnType>>
Foam::FieldFunction1<Function1Type>::value
88
89
90
91
(
    const scalarField& x
) const
{
92
    tmp<Field<Type>> tfld(new Field<Type>(x.size()));
93
    Field<Type>& fld = tfld.ref();
94
95
96

    forAll(x, i)
    {
97
        fld[i] = Function1Type::value(x[i]);
98
99
100
101
102
    }
    return tfld;
}


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
template<class Function1Type>
Foam::FieldFunction1<Function1Type>::FieldFunction1
(
    const word& entryName,
    const dictionary& dict
)
:
    Function1Type(entryName, dict)
{}


template<class Function1Type>
Foam::tmp<Foam::Function1<typename Function1Type::returnType>>
Foam::FieldFunction1<Function1Type>::clone() const
{
    return tmp<Function1<Type>>
    (
        new FieldFunction1<Function1Type>(*this)
    );
}


template<class Function1Type>
Foam::tmp<Foam::Field<typename Function1Type::returnType>>
Foam::FieldFunction1<Function1Type>::integrate
128
129
130
131
132
(
    const scalarField& x1,
    const scalarField& x2
) const
{
133
    tmp<Field<Type>> tfld(new Field<Type>(x1.size()));
134
    Field<Type>& fld = tfld.ref();
135
136
137

    forAll(x1, i)
    {
138
        fld[i] = Function1Type::integrate(x1[i], x2[i]);
139
    }
140

141
142
143
144
    return tfld;
}


Henry Weller's avatar
Henry Weller committed
145
146
147
148
149
150
151
template<class Type>
void Foam::Function1<Type>::writeData(Ostream& os) const
{
    os.writeKeyword(name_) << type();
}


152
153
// * * * * * * * * * * * * * *  IOStream operators * * * * * * * * * * * * * //

Henry Weller's avatar
Henry Weller committed
154
155
156
157
158
159
160
template<class Type>
Foam::Ostream& Foam::operator<<
(
    Ostream& os,
    const Function1<Type>& f1
)
{
161
    os.check(FUNCTION_NAME);
Henry Weller's avatar
Henry Weller committed
162
163
164
165
166
167
168

    os  << f1.name_;
    f1.writeData(os);

    return os;
}

169

170
// ************************************************************************* //