enginePiston.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
-------------------------------------------------------------------------------
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::enginePiston
 
Description
    Foam::enginePiston
 
SourceFiles
    enginePiston.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef enginePiston_H
#define enginePiston_H
 
#include "polyPatchID.H"
#include "coordinateSystem.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class polyMesh;
class engineTime;
 
/*---------------------------------------------------------------------------*\
                           Class enginePiston Declaration
\*---------------------------------------------------------------------------*/
 
class enginePiston
{
    // Private data
 
        //- Reference to engine mesh
        const polyMesh& mesh_;
 
        //- Reference to engine database
        const engineTime& engineDB_;
 
        //- Piston patch
        polyPatchID patchID_;
 
        //- Coordinate system
        autoPtr<coordinateSystem> csysPtr_;
 
 
        // Piston layering data
 
            //- Min layer thickness
            const scalar minLayer_;
 
            //- Max layer thickness
            const scalar maxLayer_;
 
 
    // Private Member Functions
 
        //- No copy construct
        enginePiston(const enginePiston&) = delete;
 
        //- No copy assignment
        void operator=(const enginePiston&) = delete;
 
 
public:
 
    // Static data members
 
 
    // Constructors
 
        //- Construct from components
        enginePiston
        (
            const polyMesh& mesh,
            const word& pistonPatchName,
            const autoPtr<coordinateSystem>& pistonCS,
            const scalar minLayer,
            const scalar maxLayer
 
        );
 
        //- Construct from dictionary
        enginePiston
        (
            const polyMesh& mesh,
            const dictionary& dict
        );
 
 
    //- Destructor
    ~enginePiston() = default;
 
 
    // Member Functions
 
        //- Return coordinate system
        const coordinateSystem& cs() const
        {
            return *csysPtr_;
        }
 
        //- Return ID of piston patch
        const polyPatchID& patchID() const
        {
            return patchID_;
        }
 
        // Piston layering thickness
 
            scalar minLayer() const
            {
                return minLayer_;
            }
 
            scalar maxLayer() const
            {
                return maxLayer_;
            }
 
 
        //- Write dictionary
        void writeDict(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //