137 lines
3.7 KiB
C++
137 lines
3.7 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
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/>.
|
|
|
|
Class
|
|
Foam::subModelBase
|
|
|
|
Description
|
|
Base class for surface film sub-models
|
|
|
|
SourceFiles
|
|
filmSubModelBaseI.H
|
|
filmSubModelBase.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef filmSubModelBase_H
|
|
#define filmSubModelBase_H
|
|
|
|
#include "surfaceFilmModel.H"
|
|
#include "subModelBase.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace regionModels
|
|
{
|
|
namespace surfaceFilmModels
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class filmSubModelBase Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class filmSubModelBase
|
|
:
|
|
public subModelBase
|
|
{
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Reference to the owner surface film model
|
|
surfaceFilmModel& owner_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
filmSubModelBase(surfaceFilmModel& owner);
|
|
|
|
//- Construct from owner film wihout name
|
|
filmSubModelBase
|
|
(
|
|
surfaceFilmModel& owner,
|
|
const dictionary& dict,
|
|
const word& baseName,
|
|
const word& modelType,
|
|
const word& dictExt = "Coeffs"
|
|
);
|
|
|
|
//- Construct from owner film with name
|
|
filmSubModelBase
|
|
(
|
|
const word& modelName,
|
|
surfaceFilmModel& owner,
|
|
const dictionary& dict,
|
|
const word& baseName,
|
|
const word& modelType
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~filmSubModelBase();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Flag to indicate when to write a property
|
|
virtual bool outputTime() const;
|
|
|
|
//- Return const access to the owner surface film model
|
|
inline const surfaceFilmModel& owner() const;
|
|
|
|
//- Return the reference to the owner surface film model
|
|
inline surfaceFilmModel& owner();
|
|
|
|
template<class FilmType>
|
|
inline const FilmType& filmType() const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace surfaceFilmModels
|
|
} // End namespace regionModels
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "filmSubModelBaseI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "filmSubModelBaseTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|