ignitionSite.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) 2011 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::ignitionSite
 
Description
    Foam::ignitionSite
 
SourceFiles
    ignitionSiteI.H
    ignitionSite.C
    ignitionSiteIO.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef ignitionSite_H
#define ignitionSite_H
 
#include "vector.H"
#include "labelList.H"
#include "scalarList.H"
#include "autoPtr.H"
#include "dictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class Time;
class engineTime;
class fvMesh;
 
/*---------------------------------------------------------------------------*\
                           Class ignitionSite Declaration
\*---------------------------------------------------------------------------*/
 
class ignitionSite
{
    // Private Data
 
        const Time& db_;
        const fvMesh& mesh_;
 
        dictionary ignitionSiteDict_;
 
        vector location_;
        scalar diameter_;
        scalar time_;
        scalar duration_;
        scalar strength_;
 
        labelList cells_;
        scalarList cellVolumes_;
 
        //- Current time index.
        //  Used during the update for moving meshes
        mutable label timeIndex_;
 
 
    // Private Member Functions
 
        void findIgnitionCells(const fvMesh&);
 
 
public:
 
    // Public Classes
 
        //- Read-construction of PtrLists of ignitionSite
        class iNew
        {
            const Time& db_;
            const fvMesh& mesh_;
 
        public:
 
            iNew(const Time& db, const fvMesh& mesh)
            :
                db_(db),
                mesh_(mesh)
            {}
 
            autoPtr<ignitionSite> operator()(Istream& is) const
            {
                return autoPtr<ignitionSite>::New(is, db_, mesh_);
            }
        };
 
 
    // Generated Methods
 
        //- Copy construct
        ignitionSite(const ignitionSite&) = default;
 
 
    // Constructors
 
        //- Construct from Istream and database
        ignitionSite(Istream&, const Time&, const fvMesh&);
 
        //- Construct from Istream and engineTime
        ignitionSite(Istream&, const engineTime&, const fvMesh&);
 
        //- Clone
        autoPtr<ignitionSite> clone() const
        {
            return autoPtr<ignitionSite>::New(*this);
        }
 
 
    // Member Functions
 
        // Access
 
            const vector& location() const
            {
                return location_;
            }
 
            scalar diameter() const
            {
                return diameter_;
            }
 
            scalar time() const
            {
                return time_;
            }
 
            scalar duration() const
            {
                return duration_;
            }
 
            scalar strength() const
            {
                return strength_;
            }
 
            //- Return the ignition cells updated if the mesh moved
            const labelList& cells() const;
 
            const scalarList& cellVolumes() const
            {
                return cellVolumes_;
            }
 
 
        // Check
 
            bool igniting() const;
 
            bool ignited() const;
 
 
    // Member Operators
 
        void operator=(const ignitionSite&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //