reflectionModel.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2017 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::radiation::reflectionModel
28
29Description
30 Base class for radiation scattering
31
32\*---------------------------------------------------------------------------*/
33
34#ifndef radiation_reflectionModel_H
35#define radiation_reflectionModel_H
36
37#include "IOdictionary.H"
38#include "autoPtr.H"
40#include "volFields.H"
41#include "Pair.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47namespace radiation
48{
49
50/*---------------------------------------------------------------------------*\
51 Class reflectionModel Declaration
52\*---------------------------------------------------------------------------*/
55{
56
57protected:
58
59 // Protected data
60
61 //- Reference to the fvMesh
62 const fvMesh& mesh_;
63
64
65public:
66
67 //- Runtime type information
68 TypeName("reflectionModel");
69
70 // Declare runtime constructor selection table
73 (
74 autoPtr,
77 (
78 const dictionary& dict,
79 const fvMesh& mesh
80 ),
81 (dict, mesh)
82 );
83
84
85 // Constructors
86
87 //- Construct from components
89
90
91 // Selector
94 (
95 const dictionary& dict,
96 const fvMesh& mesh
97 );
98
99
100 //- Destructor
101 virtual ~reflectionModel() = default;
102
103
104 // Member Functions
105
106 //- Return reflected direction
107 virtual vector R(const vector& incident, const vector& n) const = 0;
108
109 //- Return reflectivity from medium1 to medium2 and a incident angle.
110 virtual scalar rho(const scalar incidentAngle) const = 0;
111};
112
113
114// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116} // End namespace radiation
117} // End namespace Foam
118
119// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120
121#endif
122
123// ************************************************************************* //
#define R(A, B, C, D, E, F, K, M)
label n
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Base class for radiation scattering.
const fvMesh & mesh_
Reference to the fvMesh.
reflectionModel(const dictionary &dict, const fvMesh &mesh)
Construct from components.
virtual ~reflectionModel()=default
Destructor.
virtual vector R(const vector &incident, const vector &n) const =0
Return reflected direction.
virtual scalar rho(const scalar incidentAngle) const =0
Return reflectivity from medium1 to medium2 and a incident angle.
declareRunTimeSelectionTable(autoPtr, reflectionModel, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
TypeName("reflectionModel")
Runtime type information.
static autoPtr< reflectionModel > New(const dictionary &dict, const fvMesh &mesh)
dynamicFvMesh & mesh
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73