File size: 3,639 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 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 128 129 130 131 132 133 134 135 136 137 138 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 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::CloudSubModelBase
Description
Base class for cloud sub-models
SourceFiles
CloudSubModelBase.C
\*---------------------------------------------------------------------------*/
#ifndef CloudSubModelBase_H
#define CloudSubModelBase_H
#include "subModelBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class CloudSubModelBase Declaration
\*---------------------------------------------------------------------------*/
template<class CloudType>
class CloudSubModelBase
:
public subModelBase
{
protected:
// Protected Data
//- Reference to the cloud
CloudType& owner_;
public:
// Constructors
//- Construct null from owner cloud
CloudSubModelBase(CloudType& owner);
//- Construct from owner cloud without name
CloudSubModelBase
(
CloudType& owner,
const dictionary& dict,
const word& baseName,
const word& modelType
);
//- Construct from owner cloud with name
CloudSubModelBase
(
const word& modelName,
CloudType& owner,
const dictionary& dict,
const word& baseName,
const word& modelType
);
//- Copy constructor
CloudSubModelBase(const CloudSubModelBase<CloudType>& smb);
//- Destructor
virtual ~CloudSubModelBase();
//- Type of cloud this model was instantiated for
typedef CloudType cloudType;
// Member Functions
// Access
//- Return const access to the owner cloud
const CloudType& owner() const;
//- Flag to indicate when to write a property
virtual bool writeTime() const;
// Edit
//- Return non-const access to the owner cloud for manipulation
CloudType& owner();
// I-O
//- Write
virtual void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "CloudSubModelBase.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|