initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / lagrangian / dieselSpray / spraySubModels / injectorModel / definedHollowCone / definedHollowCone.H
blob81023e49a9df4e1b8c961d7f8b326a51d87b80c4
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::definedHollowConeInjector
28 Description
29     An injector model for hollow/solid cone injection
31     - user defined:
32       - inner/outer cone angle vs. time
33       - droplet PDF
35 \*---------------------------------------------------------------------------*/
37 #ifndef definedHollowConeInjector_H
38 #define definedHollowConeInjector_H
40 #include "injectorModel.H"
41 #include "vector.H"
42 #include "pdf.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                            Class definedHollowConeInjector Declaration
50 \*---------------------------------------------------------------------------*/
52 class definedHollowConeInjector
54     public injectorModel
57 private:
59     // Private data
61         typedef VectorSpace<Vector<scalar>, scalar, 2> pair;
63         dictionary definedHollowConeDict_;
64         autoPtr<pdf> dropletPDF_;
66         // inner and outer cone angle time histories 
67         // 2 column vectors = (time, coneAngle)
68         List<pair> innerConeAngle_;
69         List<pair> outerConeAngle_;
71         // two perpendicular vectors, perpendicular to injection direction
72         List<vector> tan1_;
73         List<vector> tan2_;
76 public:
78     //- Runtime type information
79     TypeName("definedHollowConeInjector");
82     // Constructors
84         //- Construct from components
85         definedHollowConeInjector
86         (
87             const dictionary& dict,
88             spray& sm
89         );
92     // Destructor
94         ~definedHollowConeInjector();
97     // Member Functions
99         //- Return the injected droplet diameter
100         scalar d0(const label injector, const scalar time) const;
102         //- Return the spray angle of the injector
103         vector direction
104         (
105             const label injector, 
106             const scalar time,
107             const scalar d
108         ) const;
110         scalar velocity
111         (
112             const label i,
113             const scalar time
114         ) const;
115         
116         scalar averageVelocity
117         (
118             const label i
119         ) const;
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 } // End namespace Foam
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 #endif
132 // ************************************************************************* //