BinaryCollisionModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2015 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::BinaryCollisionModel
 
Description
    Templated DSMC particle collision class
 
SourceFiles
    BinaryCollisionModel.C
    BinaryCollisionModelNew.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef BinaryCollisionModel_H
#define BinaryCollisionModel_H
 
#include "IOdictionary.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class BinaryCollisionModel Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class BinaryCollisionModel
{
    // Private data
 
        //- The cloud dictionary
        const dictionary& dict_;
 
        // reference to the owner cloud class
        CloudType& owner_;
 
        //- The coefficients dictionary
        const dictionary coeffDict_;
 
 
public:
 
    //- Runtime type information
    TypeName("BinaryCollisionModel");
 
    //- Declare runtime constructor selection table
    declareRunTimeSelectionTable
    (
        autoPtr,
        BinaryCollisionModel,
        dictionary,
        (
            const dictionary& dict,
            CloudType& owner
        ),
        (dict, owner)
    );
 
 
    // Constructors
 
        //- Construct null from owner
        BinaryCollisionModel(CloudType& owner);
 
        //- Construct from components
        BinaryCollisionModel
        (
            const dictionary& dict,
            CloudType& owner,
            const word& type
        );
 
 
    //- Destructor
    virtual ~BinaryCollisionModel();
 
 
    //- Selector
    static autoPtr<BinaryCollisionModel<CloudType> > New
    (
        const dictionary& dict,
        CloudType& owner
    );
 
 
    // Access
 
        //- Return the owner cloud object
        const CloudType& owner() const;
 
        //- Return non-const access to the owner cloud object
        CloudType& owner();
 
        //- Return the dictionary
        const dictionary& dict() const;
 
        //- Return the coefficients dictionary
        const dictionary& coeffDict() const;
 
 
    // Member Functions
 
        //- Flag to indicate whether model activates collision model
        virtual bool active() const = 0;
 
        //- Return the collision cross section * relative velocity product
        virtual scalar sigmaTcR
        (
            const typename CloudType::parcelType& pP,
            const typename CloudType::parcelType& pQ
        ) const = 0;
 
        //- Apply collision
        virtual void collide
        (
            typename CloudType::parcelType& pP,
            typename CloudType::parcelType& pQ
        ) = 0;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#define makeBinaryCollisionModel(CloudType)                                   \
                                                                              \
    defineNamedTemplateTypeNameAndDebug                                       \
    (                                                                         \
        BinaryCollisionModel<CloudType>,                                      \
        0                                                                     \
    );                                                                        \
                                                                              \
    defineTemplateRunTimeSelectionTable                                       \
    (                                                                         \
        BinaryCollisionModel<CloudType>,                                      \
        dictionary                                                            \
    );
 
 
#define makeBinaryCollisionModelType(SS, CloudType)                           \
                                                                              \
    defineNamedTemplateTypeNameAndDebug(SS<CloudType>, 0);                    \
                                                                              \
    BinaryCollisionModel<CloudType>::                                         \
        adddictionaryConstructorToTable<SS<CloudType> >                       \
            add##SS##CloudType##ConstructorToTable_;
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "BinaryCollisionModel.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //