NoPair.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2022 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::NoPair
 
Description
    Placeholder for 'none' option
 
SourceFiles
    NoPair.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef NoPair_H
#define NoPair_H
 
#include "PairModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
/*---------------------------------------------------------------------------*\
                            Class NoPair Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class NoPair
:
    public PairModel<CloudType>
{
public:
 
    //- Runtime type information
    TypeName("none");
 
 
    // Constructors
 
        //- Construct from dictionary and cloud owner
        NoPair(const dictionary& dict, CloudType& cloud);
 
 
    //- Destructor
    virtual ~NoPair() = default;
 
 
    // Member Functions
 
        //- Whether the PairModel has a timestep limit that will
        //- require subCycling
        virtual bool controlsTimestep() const;
 
        //- For PairModels that control the timestep, calculate the
        //- number of subCycles needed to satisfy the minimum
        //- allowable timestep
        virtual label nSubCycles() const;
 
        //- Calculate the pair interaction between parcels
        virtual void evaluatePair
        (
            typename CloudType::parcelType& pA,
            typename CloudType::parcelType& pB
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "NoPair.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //