viewFactor2AI.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) 2023-2024 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::VF::viewFactor2AI
28 
29 Description
30  Computes view factors according to the double area integral (2AI) method.
31 
32 Usage
33  Minimal example in \c <constant>/viewFactorsDict:
34  \verbatim
35  // Inherited entries
36  ...
37  \endverbatim
38 
39  The inherited entries are elaborated in:
40  - \link viewFactorModel.H \endlink
41 
42 SourceFiles
43  viewFactorModel.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef Foam_vf_viewFactor2AI_H
48 #define Foam_vf_viewFactor2AI_H
49 
50 #include "viewFactorModel.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 namespace VF
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class viewFactor2AI Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 class viewFactor2AI
65 :
66  public viewFactorModel
67 {
68 
69 protected:
70 
71  // Protected Member Functions
72 
73  //- Calculate view factor using the double-area integral
74  static scalar calculateFij
75  (
76  const point& xi,
77  const point& xj,
78  const vector& dAi,
79  const vector& dAj
80  );
81 
82  //- Calculate
84  (
85  const labelListList& visibleFaceFaces,
86  const pointField& compactCf,
87  const vectorField& compactSf,
88  const List<List<vector>>& compactFineSf,
89  const List<List<point>>& compactFineCf,
90  const DynamicList<List<point>>& compactPoints,
91  const DynamicList<label>& compactPatchId
92  ) const;
93 
94 
95 public:
96 
97  //- Runtime type information
98  TypeName("viewFactor2AI");
99 
100  //- Constructor
101  viewFactor2AI(const fvMesh& mesh, const dictionary& dict);
102 
103  //- Destructor
104  virtual ~viewFactor2AI() = default;
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace VF
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
viewFactor2AI(const fvMesh &mesh, const dictionary &dict)
Constructor.
virtual ~viewFactor2AI()=default
Destructor.
dynamicFvMesh & mesh
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects...
Definition: DynamicList.H:51
virtual void calculate()
Calculate the view factors.
TypeName("viewFactor2AI")
Runtime type information.
A Vector of values with scalar precision, where scalar is float/double depending on the compilation f...
A base class for viewFactor models.
Computes view factors according to the double area integral (2AI) method.
Definition: viewFactor2AI.H:59
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
static scalar calculateFij(const point &xi, const point &xj, const vector &dAi, const vector &dAj)
Calculate view factor using the double-area integral.
Namespace for OpenFOAM.