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-2022 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  const auto* filmPtr = isA<FilmType>(filmModel_);
41 
42  if (!filmPtr)
43  {
45  << "Model " << this->modelType() << " requested film type "
46  << FilmType::typeName << " but film is type " << filmModel_.type()
47  << abort(FatalError);
48  }
49 
50  return *filmPtr;
51 }
52 
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 } // End namespace areaSurfaceFilmModels
57 } // End namespace regionModels
58 } // End namespace Foam
59 
60 // ************************************************************************* //
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
liquidFilmBase & filmModel_
Reference to the film surface film model.
errorManip< error > abort(error &err)
Definition: errorManip.H:139
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:116
Namespace for OpenFOAM.