ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / lagrangian / dieselSpray / spraySubModels / injectorModel / definedHollowCone / definedHollowCone.H
blob0840eb1d4a1969a7856d0a6fe94bef835286e5a4
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::definedHollowConeInjector
27 Description
28     An injector model for hollow/solid cone injection
30     - user defined:
31       - inner/outer cone angle vs. time
32       - droplet distribution model
34 \*---------------------------------------------------------------------------*/
36 #ifndef definedHollowConeInjector_H
37 #define definedHollowConeInjector_H
39 #include "injectorModel.H"
40 #include "vector.H"
41 #include "distributionModel.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                   Class definedHollowConeInjector Declaration
49 \*---------------------------------------------------------------------------*/
51 class definedHollowConeInjector
53     public injectorModel
56 private:
58     // Private data
60         typedef VectorSpace<Vector<scalar>, scalar, 2> pair;
62         dictionary definedHollowConeDict_;
63         autoPtr<distributionModels::distributionModel> sizeDistribution_;
65         // inner and outer cone angle time histories
66         // 2 column vectors = (time, coneAngle)
67         List<pair> innerConeAngle_;
68         List<pair> outerConeAngle_;
71 public:
73     //- Runtime type information
74     TypeName("definedHollowConeInjector");
77     // Constructors
79         //- Construct from components
80         definedHollowConeInjector(const dictionary& dict, spray& sm);
83     //- Destructor
84     virtual ~definedHollowConeInjector();
87     // Member Functions
89         //- Return the injected droplet diameter
90         scalar d0(const label injector, const scalar time) const;
92         //- Return the spray angle of the injector
93         vector direction
94         (
95             const label injector,
96             const label hole,
97             const scalar time,
98             const scalar d
99         ) const;
101         scalar velocity(const label i, const scalar time) const;
103         scalar averageVelocity( const label i) const;
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 } // End namespace Foam
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 #endif
115 // ************************************************************************* //