Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / finiteVolume / cfdTools / general / fieldSources / timeActivatedExplicitSource / TimeActivatedExplicitSourceI.H
blobace611df5599c28b8a5d967a759f09fad7c7b2a3
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 \*---------------------------------------------------------------------------*/
26 #include "TimeActivatedExplicitSource.H"
28 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
30 template<class Type>
31 inline const Foam::word& Foam::TimeActivatedExplicitSource<Type>::name() const
33     return name_;
37 template<class Type>
38 inline const Foam::fvMesh& Foam::TimeActivatedExplicitSource<Type>::mesh() const
40     return mesh_;
44 template<class Type>
45 inline bool Foam::TimeActivatedExplicitSource<Type>::active() const
47     return active_;
51 template<class Type>
52 inline Foam::scalar Foam::TimeActivatedExplicitSource<Type>::timeStart() const
54     return timeStart_;
58 template<class Type>
59 inline Foam::scalar Foam::TimeActivatedExplicitSource<Type>::duration() const
61     return duration_;
65 template<class Type>
66 inline Foam::scalar Foam::TimeActivatedExplicitSource<Type>::timeEnd() const
68     return timeStart_ + duration_;
72 template<class Type>
73 inline const typename Foam::TimeActivatedExplicitSource<Type>::volumeModeType&
74 Foam::TimeActivatedExplicitSource<Type>::volumeMode() const
76     return volumeMode_;
80 template<class Type>
81 inline const typename Foam::TimeActivatedExplicitSource<Type>::
82 selectionModeType&
83 Foam::TimeActivatedExplicitSource<Type>::selectionMode() const
85     return selectionMode_;
89 template<class Type>
90 inline const Foam::List<Foam::point>&
91 Foam::TimeActivatedExplicitSource<Type>::points() const
93     return points_;
97 template<class Type>
98 inline const Foam::word&
99 Foam::TimeActivatedExplicitSource<Type>::cellSetName() const
101     return cellSetName_;
105 template<class Type>
106 inline Foam::scalar Foam::TimeActivatedExplicitSource<Type>::V() const
108     return V_;
112 template<class Type>
113 inline const Foam::labelList&
114 Foam::TimeActivatedExplicitSource<Type>::cells() const
116     return cells_;
120 template<class Type>
121 inline const Foam::List<typename Foam::TimeActivatedExplicitSource<Type>::
122 fieldNameValuePair>&
123 Foam::TimeActivatedExplicitSource<Type>::fieldData() const
125     return fieldData_;
129 template<class Type>
130 inline const Foam::labelList&
131 Foam::TimeActivatedExplicitSource<Type>::fieldIds() const
133     return fieldIds_;
137 template<class Type>
138 inline Foam::word& Foam::TimeActivatedExplicitSource<Type>::name()
140     return name_;
144 template<class Type>
145 inline bool& Foam::TimeActivatedExplicitSource<Type>::active()
147     return active_;
151 template<class Type>
152 inline Foam::scalar& Foam::TimeActivatedExplicitSource<Type>::timeStart()
154     return timeStart_;
158 template<class Type>
159 inline Foam::scalar& Foam::TimeActivatedExplicitSource<Type>::duration()
161     return duration_;
165 template<class Type>
166 inline typename Foam::TimeActivatedExplicitSource<Type>::volumeModeType&
167 Foam::TimeActivatedExplicitSource<Type>::volumeMode()
169     return volumeMode_;
173 template<class Type>
174 inline typename Foam::TimeActivatedExplicitSource<Type>::selectionModeType&
175 Foam::TimeActivatedExplicitSource<Type>::selectionMode()
177     return selectionMode_;
181 template<class Type>
182 inline Foam::List<Foam::point>&
183 Foam::TimeActivatedExplicitSource<Type>::points()
185     return points_;
189 template<class Type>
190 inline Foam::word& Foam::TimeActivatedExplicitSource<Type>::cellSetName()
192     return cellSetName_;
196 template<class Type>
197 inline Foam::scalar& Foam::TimeActivatedExplicitSource<Type>::V()
199     return V_;
203 template<class Type>
204 inline Foam::labelList& Foam::TimeActivatedExplicitSource<Type>::cells()
206     return cells_;
210 template<class Type>
211 inline Foam::List
213     typename Foam::TimeActivatedExplicitSource<Type>::fieldNameValuePair
215 Foam::TimeActivatedExplicitSource<Type>::fieldData()
217     return fieldData_;
221 template<class Type>
222 inline Foam::labelList& Foam::TimeActivatedExplicitSource<Type>::fieldIds()
224     return fieldIds_;
228 // ************************************************************************* //