mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
170 lines
4.5 KiB
C++
170 lines
4.5 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2017 OpenFOAM Foundation
|
|
Copyright (C) 2020 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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::CloudFunctionObjectList
|
|
|
|
Description
|
|
List of cloud function objects
|
|
|
|
SourceFiles
|
|
CloudFunctionObjectListI.H
|
|
CloudFunctionObjectList.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef CloudFunctionObjectList_H
|
|
#define CloudFunctionObjectList_H
|
|
|
|
#include "PtrList.H"
|
|
#include "CloudFunctionObject.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class CloudFunctionObjectList Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class CloudType>
|
|
class CloudFunctionObjectList
|
|
:
|
|
public PtrList<CloudFunctionObject<CloudType>>
|
|
{
|
|
private:
|
|
|
|
//- Convenience typedef for parcel type
|
|
typedef typename CloudType::parcelType parcelType;
|
|
|
|
|
|
protected:
|
|
|
|
// Protected Data
|
|
|
|
//- Reference to the owner cloud
|
|
const CloudType& owner_;
|
|
|
|
//- Dictionary
|
|
const dictionary dict_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Null constructor
|
|
CloudFunctionObjectList(CloudType& owner);
|
|
|
|
//- Construct from mesh
|
|
CloudFunctionObjectList
|
|
(
|
|
CloudType& owner,
|
|
const dictionary& dict,
|
|
const bool readFields
|
|
);
|
|
|
|
//- Construct copy
|
|
CloudFunctionObjectList(const CloudFunctionObjectList& ppml);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~CloudFunctionObjectList() = default;
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Return const access to the cloud owner
|
|
inline const CloudType& owner() const;
|
|
|
|
//- Return reference to the cloud owner
|
|
inline CloudType& owner();
|
|
|
|
//- Return the forces dictionary
|
|
inline const dictionary& dict() const;
|
|
|
|
|
|
// Evaluation
|
|
|
|
//- Pre-evolve hook
|
|
virtual void preEvolve
|
|
(
|
|
const typename parcelType::trackingData& td
|
|
);
|
|
|
|
//- Post-evolve hook
|
|
virtual void postEvolve
|
|
(
|
|
const typename parcelType::trackingData& td
|
|
);
|
|
|
|
//- Post-move hook
|
|
virtual bool postMove
|
|
(
|
|
parcelType& p,
|
|
const scalar dt,
|
|
const point& position0,
|
|
const typename parcelType::trackingData& td
|
|
);
|
|
|
|
//- Post-patch hook
|
|
virtual bool postPatch
|
|
(
|
|
parcelType& p,
|
|
const polyPatch& pp,
|
|
const typename parcelType::trackingData& td
|
|
);
|
|
|
|
//- Post-face hook
|
|
virtual bool postFace
|
|
(
|
|
parcelType& p,
|
|
const typename parcelType::trackingData& td
|
|
);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "CloudFunctionObjectListI.H"
|
|
|
|
#ifdef NoRepository
|
|
#include "CloudFunctionObjectList.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|