Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
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::VF::viewFactor2AI
28
29Description
30 Computes view factors according to the double area integral (2AI) method.
31
32Usage
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
42SourceFiles
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
54namespace Foam
55{
56
57namespace VF
58{
60/*---------------------------------------------------------------------------*\
61 Class viewFactor2AI Declaration
62\*---------------------------------------------------------------------------*/
63
64class viewFactor2AI
65:
66 public viewFactorModel
67{
68
69protected:
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 UList<List<vector>>& compactFineSf,
89 const UList<List<point>>& compactFineCf,
90 const UList<List<point>>& compactPoints,
91 const UList<label>& compactPatchId
92 ) const;
93
94
95public:
96
97 //- Runtime type information
98 TypeName("viewFactor2AI");
100 //- Constructor
101 viewFactor2AI(const fvMesh& mesh, const dictionary& dict);
102
103 //- Destructor
104 virtual ~viewFactor2AI() = default;
105};
106
107
108// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110} // End namespace VF
111} // End namespace Foam
112
113// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114
115#endif
116
117// ************************************************************************* //
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition List.H:72
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition UList.H:89
virtual ~viewFactor2AI()=default
Destructor.
viewFactor2AI(const fvMesh &mesh, const dictionary &dict)
Constructor.
TypeName("viewFactor2AI")
Runtime type information.
static scalar calculateFij(const point &xi, const point &xj, const vector &dAi, const vector &dAj)
Calculate view factor using the double-area integral.
virtual scalarListList calculate(const labelListList &visibleFaceFaces, const pointField &compactCf, const vectorField &compactSf, const UList< List< vector > > &compactFineSf, const UList< List< point > > &compactFineCf, const UList< List< point > > &compactPoints, const UList< label > &compactPatchId) const
Calculate.
viewFactorModel(const viewFactorModel &)=delete
No copy construct.
virtual void calculate()
Calculate the view factors.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Mesh data needed to do the Finite Volume discretisation.
Definition fvMesh.H:85
dynamicFvMesh & mesh
A namespace for various viewFactor model implementations.
Namespace for OpenFOAM.
List< scalarList > scalarListList
List of scalarList.
Definition scalarList.H:35
List< labelList > labelListList
List of labelList.
Definition labelList.H:38
Field< vector > vectorField
Specialisation of Field<T> for vector.
vector point
Point is a vector.
Definition point.H:37
vectorField pointField
pointField is a vectorField.
Vector< scalar > vector
Definition vector.H:57
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition typeInfo.H:68