filmSubModelBaseTemplates.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 namespace Foam
29 {
30 namespace regionModels
31 {
32 namespace areaSurfaceFilmModels
33 {
34 
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36 
37 template<class FilmType>
38 const FilmType& filmSubModelBase::filmType() const
39 {
40  if (!isA<FilmType>(filmModel_))
41  {
43  << "Model " << this->modelType() << " requested film type "
44  << FilmType::typeName << " but film is type " << filmModel_.type()
45  << abort(FatalError);
46  }
47 
48  return refCast<const FilmType>(filmModel_);
49 }
50 
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 } // End namespace areaSurfaceFilmModels
55 } // End namespace regionModels
56 } // End namespace Foam
57 
58 // ************************************************************************* //
Foam::FatalError
error FatalError
Foam::regionModels::areaSurfaceFilmModels::filmSubModelBase::filmModel_
liquidFilmBase & filmModel_
Reference to the film surface film model.
Definition: filmSubModelBase.H:65
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::subModelBase::modelType
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:125
Foam::regionModels::areaSurfaceFilmModels::filmSubModelBase::filmType
const FilmType & filmType() const
Definition: filmSubModelBaseTemplates.C:38
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453