DTRMParticleI.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 -------------------------------------------------------------------------------
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 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
31 (
33  const interpolationCell<scalar>& aInterp,
34  const interpolationCell<scalar>& eInterp,
35  const interpolationCell<scalar>& EInterp,
36  const interpolationCell<scalar>& TInterp,
37  const interpolationCellPoint<vector>& nHatInterp,
38  const labelField& relfectedCell,
39  const UPtrList<reflectionModel>& reflection,
41 )
42 :
44  aInterp_(aInterp),
45  eInterp_(eInterp),
46  EInterp_(EInterp),
47  TInterp_(TInterp),
48  nHatInterp_(nHatInterp),
49  relfectedCells_(relfectedCell),
50  reflection_(reflection),
51  Q_(Q)
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56 
59 {
60  return aInterp_;
61 }
62 
63 
66 {
67  return eInterp_;
68 }
69 
70 
73 {
74  return EInterp_;
75 }
76 
77 
80 {
81  return TInterp_;
82 }
83 
86 {
87  return nHatInterp_;
88 }
89 
90 inline const Foam::labelField&
92 {
93  return relfectedCells_;
94 }
95 
96 
99 {
100  return reflection_;
101 }
102 
103 
104 inline Foam::scalar& Foam::DTRMParticle::trackingData::Q(label celli)
105 {
106  return Q_[celli];
107 }
108 
109 
110 inline const Foam::point& Foam::DTRMParticle::p0() const
111 {
112  return p0_;
113 }
114 
115 
116 inline const Foam::point& Foam::DTRMParticle::p1() const
117 {
118  return p1_;
119 }
120 
121 
122 inline Foam::scalar Foam::DTRMParticle::I0() const
123 {
124  return I0_;
125 }
126 
127 
128 inline Foam::scalar Foam::DTRMParticle::I() const
129 {
130  return I_;
131 }
132 
133 
134 inline Foam::scalar Foam::DTRMParticle::dA() const
135 {
136  return dA_;
137 }
138 
139 
140 inline Foam::scalar& Foam::DTRMParticle::dA()
141 {
142  return dA_;
143 }
144 
145 
147 {
148  return p1_;
149 }
150 
151 
152 inline Foam::scalar& Foam::DTRMParticle::I0()
153 {
154  return I0_;
155 }
156 
157 
158 inline Foam::scalar& Foam::DTRMParticle::I()
159 {
160  return I_;
161 }
162 
163 
164 // ************************************************************************* //
Foam::DTRMParticle::trackingData::eInterp
const interpolationCell< scalar > & eInterp() const
Definition: DTRMParticleI.H:65
Foam::DTRMParticle::p1
const point & p1() const
Return const access to the target position.
Definition: DTRMParticleI.H:116
Foam::DTRMParticle::trackingData::Q
scalar & Q(label celli)
Definition: DTRMParticleI.H:104
Foam::DTRMParticle::trackingData::aInterp
const interpolationCell< scalar > & aInterp() const
Definition: DTRMParticleI.H:58
Foam::DTRMParticle::trackingData::relfectedCells
const labelField & relfectedCells() const
Definition: DTRMParticleI.H:91
Foam::DTRMParticle::trackingData::TInterp
const interpolationCell< scalar > & TInterp() const
Definition: DTRMParticleI.H:79
Foam::DTRMParticle::trackingData::nHatInterp
const interpolationCellPoint< vector > & nHatInterp() const
Definition: DTRMParticleI.H:85
Foam::DTRMParticle::dA
scalar dA() const
Return const access dA.
Definition: DTRMParticleI.H:134
Foam::DTRMParticle::trackingData::reflection
const UPtrList< reflectionModel > & reflection() const
Definition: DTRMParticleI.H:98
Foam::interpolationCell< scalar >
Foam::Field< label >
Foam::DTRMParticle::p0
const point & p0() const
Return const access to the initial position.
Definition: DTRMParticleI.H:110
Foam::interpolationCellPoint
Given cell centre values and point (vertex) values decompose into tetrahedra and linear interpolate w...
Definition: interpolationCellPoint.H:50
Foam::DTRMParticle::I0
scalar I0() const
Return const access to the initial intensity.
Definition: DTRMParticleI.H:122
Foam::DTRMParticle::I
scalar I() const
Return const access to the current intensity.
Definition: DTRMParticleI.H:128
Foam::UPtrList
A list of pointers to objects of type <T>, without allocation/deallocation management of the pointers...
Definition: UPtrList.H:62
Foam::DTRMParticle::trackingData::EInterp
const interpolationCell< scalar > & EInterp() const
Definition: DTRMParticleI.H:72
Foam::Vector< scalar >
Foam::Cloud
Base cloud calls templated on particle type.
Definition: Cloud.H:55
Foam::DTRMParticle::trackingData::trackingData
trackingData(Cloud< DTRMParticle > &spc, const interpolationCell< scalar > &aInterp, const interpolationCell< scalar > &eInterp, const interpolationCell< scalar > &EInterp, const interpolationCell< scalar > &TInterp, const interpolationCellPoint< vector > &nHatInterp, const labelField &, const UPtrList< reflectionModel > &, volScalarField &Q)
Definition: DTRMParticleI.H:31
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::particle::trackingData
Definition: particle.H:95