PairCollisionRecordI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
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.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
28 template<class Type>
30 (
31  label queryOrigProcOfOther,
32  label queryOrigIdOfOther
33 ) const
34 {
35  return
36  (
37  queryOrigProcOfOther == origProcOfOther()
38  && queryOrigIdOfOther == origIdOfOther()
39  );
40 }
41 
42 
43 template<class Type>
45 {
46  return mag(origProcOfOther_) - 1;
47 }
48 
49 
50 template<class Type>
52 {
53  return origIdOfOther_;
54 }
55 
56 
57 template<class Type>
58 inline const Type&
60 {
61  return data_;
62 }
63 
64 
65 template<class Type>
67 {
68  return data_;
69 }
70 
71 
72 template<class Type>
74 {
75  return pos0(origProcOfOther_);
76 }
77 
78 
79 template<class Type>
81 {
82  origProcOfOther_ = origProcOfOther() + 1;
83 }
84 
85 
86 template<class Type>
88 {
89  origProcOfOther_ = -(origProcOfOther() + 1);
90 }
91 
92 
93 // * * * * * * * * * * * * * * Friend Operators * * * * * * * * * * * * * * //
94 
95 template<class Type>
96 inline bool Foam::operator==
97 (
100 )
101 {
102  return
103  (
104  a.origProcOfOther_ == b.origProcOfOther_
105  && a.origIdOfOther_ == b.origIdOfOther_
106  && a.data_ == b.data_
107  );
108 }
109 
110 
111 template<class Type>
112 inline bool Foam::operator!=
113 (
114  const PairCollisionRecord<Type>& a,
116 )
117 {
118  return !(a == b);
119 }
120 
121 
122 // ************************************************************************* //
void setUnaccessed()
Set the accessed property of the record to unaccessed.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
bool match(label queryOrigProcOfOther, label queryOrigIdOfOther) const
bool accessed() const
Return the accessed status of the record.
const Type & collisionData() const
Return access to the collision data.
label origIdOfOther() const
Return the origIdOfOther data.
label origProcOfOther() const
Return the origProcOfOther data.
const dimensionedScalar b
Wien displacement law constant: default SI units: [m.K].
Definition: createFields.H:27
void setAccessed()
Set the accessed property of the record to accessed.
dimensionedScalar pos0(const dimensionedScalar &ds)
Record of a collision between the particle holding the record and the particle with the stored id...
dimensioned< scalar > mag(const dimensioned< Type > &)