ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
polygon_ Class Reference

#include <ERF_EBPolygon.H>

Collaboration diagram for polygon_:

Public Member Functions

AMREX_GPU_HOST_DEVICE polygon_ (amrex::RealVect a_point, amrex::RealVect a_normal)
 
AMREX_GPU_HOST_DEVICE polygon_ ()
 
AMREX_GPU_HOST_DEVICE void add_vertex (amrex::RealVect const &a_v)
 
AMREX_GPU_HOST_DEVICE int get_num_vertices ()
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void set_area (amrex::Real const &a_area)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void define ()
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int ok () const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real area () const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real distance (amrex::RealVect const &a_point) const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::RealVect get_centroid () const noexcept
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::RealVect normal () const noexcept
 
void report (int const a_id, amrex::RealVect a_v0)
 
void debug (int const a_id)
 
void debug ()
 

Private Attributes

int const m_cell_face
 
amrex::RealVect const m_eb_point
 
amrex::RealVect const m_eb_normal
 
int m_defined
 
int m_num_vertices
 
amrex::Real m_area
 
int m_sorted
 
amrex::Array< amrex::RealVect, m_max_verticesm_vertices
 
amrex::GpuArray< amrex::Real, m_max_verticesm_theta
 
amrex::RealVect m_zdir
 

Static Private Attributes

static constexpr int m_max_vertices = 6
 

Constructor & Destructor Documentation

◆ polygon_() [1/2]

AMREX_GPU_HOST_DEVICE polygon_::polygon_ ( amrex::RealVect  a_point,
amrex::RealVect  a_normal 
)
inline
16  : m_cell_face(1)
17  , m_eb_point(a_point)
18  , m_eb_normal(a_normal)
19  , m_defined(0)
20  , m_num_vertices(0)
21  , m_area(0.)
22  , m_sorted(0)
23  , m_vertices({amrex::RealVect(0.), amrex::RealVect(0.), amrex::RealVect(0.),
24  amrex::RealVect(0.), amrex::RealVect(0.), amrex::RealVect(0.)})
25  , m_zdir(0.)
26  {}
int m_defined
Definition: ERF_EBPolygon.H:242
amrex::Real m_area
Definition: ERF_EBPolygon.H:246
amrex::Array< amrex::RealVect, m_max_vertices > m_vertices
Definition: ERF_EBPolygon.H:250
int const m_cell_face
Definition: ERF_EBPolygon.H:237
int m_sorted
Definition: ERF_EBPolygon.H:248
amrex::RealVect const m_eb_normal
Definition: ERF_EBPolygon.H:240
int m_num_vertices
Definition: ERF_EBPolygon.H:244
amrex::RealVect const m_eb_point
Definition: ERF_EBPolygon.H:239
amrex::RealVect m_zdir
Definition: ERF_EBPolygon.H:254

◆ polygon_() [2/2]

AMREX_GPU_HOST_DEVICE polygon_::polygon_ ( )
inline
30  : m_cell_face(0)
31  , m_eb_point(0.)
32  , m_eb_normal(0.)
33  , m_defined(0)
34  , m_num_vertices(0)
35  , m_area(0.)
36  , m_sorted(0)
37  , m_vertices({amrex::RealVect(0.), amrex::RealVect(0.), amrex::RealVect(0.),
38  amrex::RealVect(0.), amrex::RealVect(0.), amrex::RealVect(0.)})
39  , m_zdir(0.)
40  {}

Member Function Documentation

◆ add_vertex()

AMREX_GPU_HOST_DEVICE void polygon_::add_vertex ( amrex::RealVect const &  a_v)
inline
43  {
44  for ( int i(0); i<m_num_vertices; ++i) {
45  if ( amrex::almostEqual(m_vertices[i][0],a_v[0]) &&
46  amrex::almostEqual(m_vertices[i][1],a_v[1]) &&
47  amrex::almostEqual(m_vertices[i][2],a_v[2]) ) {
48  return;
49  }
50  }
51  AMREX_ASSERT( m_num_vertices < m_max_vertices );
54  }
static constexpr int m_max_vertices
Definition: ERF_EBPolygon.H:235

Referenced by eb_cut_cell_::calc_edge_intersections(), and eb_cut_cell_::set_covered_regular_cell_vertices().

Here is the caller graph for this function:

◆ area()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real polygon_::area ( ) const
inlinenoexcept
154  {
155  AMREX_ALWAYS_ASSERT( ok() ); // <-------------------------------------- TODO remove ALWAYS
156  return m_area;
157  }
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int ok() const noexcept
Definition: ERF_EBPolygon.H:150

Referenced by eb_cut_cell_::areaBoun(), eb_cut_cell_::centVol(), get_centroid(), and eb_cut_cell_::volume().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ debug() [1/2]

void polygon_::debug ( )
inline
229  {
230  debug(-1);
231  }
void debug()
Definition: ERF_EBPolygon.H:229

◆ debug() [2/2]

void polygon_::debug ( int const  a_id)
inline
223  {
224  amrex::Print() << "EBPolygon: id = " << a_id << ", m_num_vertices = " << m_num_vertices << '\n';
225  for (int i(0); i<m_num_vertices; ++i) {
226  amrex::Print() << "EBPolygon: v" << i << ": " << m_vertices[i] << '\n';
227  }
228  }

◆ define()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void polygon_::define ( )
inline
65  {
66 
67  AMREX_ALWAYS_ASSERT( m_defined == 0 ); // TODO ---------------------------- remove ALWAYS
68 
69  m_defined = 1;
70 
71  // We need at least 3 vertices.
72  if (m_num_vertices < 3) { return; }
73 
74  // Check to see if the vertices of the face are inside or outside of the plane.
75  // If they are outside, this face doesn't belong to the volume.
76  if ( m_cell_face ) {
77  for ( int i(0); i<m_num_vertices; ++i) {
78  if ((m_eb_normal.dotProduct(m_vertices[i] - m_eb_point)) >= 0.) {
79  } else {
80  }
81  }
82  }
83 
84  // Calculate the centroid of the polygon.
85  amrex::RealVect centroid = get_centroid();
86 
87  // Shift the vertices relative to the centroid
88  amrex::Array<amrex::RealVect,m_max_vertices> vertex_cent;
89  for ( int i(0); i<m_num_vertices; ++i) {
90  vertex_cent[i] = m_vertices[i] - centroid;
91  }
92 
93  // Compute the normal vector m_zdir by cross product of two vectors in vertex_cent.
94  // Choose the vectors with the largest cross-product magnitude.
95  amrex::RealVect v_normal;
96  amrex::Real max_norm2 = -1.0;
97  const amrex::RealVect& vertex_cent_0 = vertex_cent[0];
98 
99  for (int i = 1; i < m_num_vertices; ++i)
100  {
101  amrex::RealVect vi = vertex_cent[i];
102  amrex::RealVect v_cross = vertex_cent_0.crossProduct(vi);
103  amrex::Real n2 = v_cross.radSquared();
104  if (n2 > max_norm2)
105  {
106  max_norm2 = n2;
107  v_normal = v_cross;
108  }
109  }
110  if (!amrex::almostEqual(max_norm2, 0.0))
111  {
112  v_normal /= std::sqrt(max_norm2);
113  }
114  m_zdir = v_normal;
115 
116  //
117 
118  m_theta[0] = 0.0;
119  for ( int i(1); i<m_num_vertices; ++i) {
120 
121  m_theta[i] = std::atan2(m_zdir.dotProduct( vertex_cent[0].crossProduct(vertex_cent[i]) ),
122  vertex_cent[0].dotProduct(vertex_cent[i]));
123 
124  m_theta[i] += ((m_theta[i] >= 0.) ? 0.0 : 2.0*PI);
125  }
126 
127  // Sort counter clockwise based on theta.
128  for (int i(0); i<m_num_vertices; ++i) {
129  for (int j(0); j < m_num_vertices-i-1; ++j) {
130  if ( m_theta[j] > m_theta[j+1] ) {
131  amrex::Swap(m_theta[j], m_theta[j+1]);
132  amrex::Swap(m_vertices[j], m_vertices[j+1]);
133  amrex::Swap(vertex_cent[j], vertex_cent[j+1]);
134  }
135  } // j-loop
136  } // i-loop
137  m_sorted = 1;
138 
139  // Compute areas of triangles
140 
141  for (int i(0); i<m_num_vertices; ++i) {
142  int const j( (i+1 == m_num_vertices) ? 0 : i+1 );
143  amrex::RealVect vi_cross_vj = vertex_cent[i].crossProduct(vertex_cent[j]);
144  m_area += 0.5*vi_cross_vj.vectorLength();
145  }
146  AMREX_ALWAYS_ASSERT( m_area > 0. ); // <------------------------------- TODO remove ALWAYS
147  } // void define
constexpr amrex::Real PI
Definition: ERF_Constants.H:6
amrex::Real Real
Definition: ERF_ShocInterface.H:19
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::RealVect get_centroid() const noexcept
Definition: ERF_EBPolygon.H:169
amrex::GpuArray< amrex::Real, m_max_vertices > m_theta
Definition: ERF_EBPolygon.H:252
real(c_double), private vi
Definition: ERF_module_mp_morr_two_moment.F90:219
Here is the call graph for this function:

◆ distance()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real polygon_::distance ( amrex::RealVect const &  a_point) const
inlinenoexcept
161  {
162  AMREX_ALWAYS_ASSERT( m_defined == 1 ); // <--------------------------- TODO remove ALWAYS
163  amrex::RealVect x0 = a_point - m_vertices[0];
164  return amrex::Math::abs(x0.dotProduct(m_zdir));
165  }

Referenced by report(), and eb_cut_cell_::volume().

Here is the caller graph for this function:

◆ get_centroid()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::RealVect polygon_::get_centroid ( ) const
inlinenoexcept
169  {
170  amrex::RealVect cent(0.);
171  if (m_num_vertices==3) {
172  cent = (m_vertices[0] + m_vertices[1] + m_vertices[2]) / 3.0;
173  } else {
174  // Loop over sub-triangles
175  amrex::Real area(0.);
176  for ( int i(0); i<m_num_vertices-2; ++i) {
177  amrex::RealVect const v0 (m_vertices[i+1] - m_vertices[0]);
178  amrex::RealVect const v1 (m_vertices[i+2] - m_vertices[0]);
179  amrex::RealVect v0_cross_v1 = v0.crossProduct(v1);
180  amrex::Real area_tri = 0.5 * v0_cross_v1.vectorLength();
181  amrex::RealVect cent_tri = (m_vertices[0] + m_vertices[i+1] + m_vertices[i+2]) / 3.0;
182  area += area_tri;
183  cent += area_tri * cent_tri;
184  }
185  cent = cent / area;
186  }
187  return cent;
188  }
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real area() const noexcept
Definition: ERF_EBPolygon.H:154

Referenced by eb_cut_cell_::centBoun(), eb_cut_cell_::centVol(), define(), and report().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_num_vertices()

AMREX_GPU_HOST_DEVICE int polygon_::get_num_vertices ( )
inline
57  {
58  return m_num_vertices;
59  }

◆ normal()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::RealVect polygon_::normal ( ) const
inlinenoexcept
192  {
193  return m_zdir;
194  }

◆ ok()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int polygon_::ok ( ) const
inlinenoexcept
151  { return ((m_area > 0. || (m_area == 0. && m_defined == 1)) ? 1 : 0); }

Referenced by area(), report(), and eb_cut_cell_::volume().

Here is the caller graph for this function:

◆ report()

void polygon_::report ( int const  a_id,
amrex::RealVect  a_v0 
)
inline
201  {
202 
203 #ifndef AMREX_USE_GPU
204  amrex::RealVect centroid = get_centroid();
205  amrex::Print() << "Face " << a_id
206  << " -------------------------------------------\n"
207  << "\nok? " << (ok() ? "yes" : "no") << "\n\n";
208  for (int i(0); i<m_num_vertices; ++i) {
209  amrex::Print() << "v" << i << ": " << m_vertices[i] << '\n';
210  }
211  amrex::Print() << "\nvc: " << " " << centroid << "\n";
212 
213  amrex::Real const dist = distance( a_v0 );
214  // amrex::Real const vol = ok() ? m_area * dist : 0.;
215 
216  amrex::Print() << "\narea: " << m_area
217  << "\ndistance: " << dist
218  << "\nvolume: " << dist*m_area
219  << "\n==================================================\n\n";
220 #endif
221  }
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real distance(amrex::RealVect const &a_point) const noexcept
Definition: ERF_EBPolygon.H:161
Here is the call graph for this function:

◆ set_area()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void polygon_::set_area ( amrex::Real const &  a_area)
inline
62 { m_area = a_area; }

Referenced by eb_cut_cell_::set_regular().

Here is the caller graph for this function:

Member Data Documentation

◆ m_area

amrex::Real polygon_::m_area
private

Referenced by area(), define(), ok(), report(), and set_area().

◆ m_cell_face

int const polygon_::m_cell_face
private

Referenced by define().

◆ m_defined

int polygon_::m_defined
private

Referenced by define(), distance(), and ok().

◆ m_eb_normal

amrex::RealVect const polygon_::m_eb_normal
private

Referenced by define().

◆ m_eb_point

amrex::RealVect const polygon_::m_eb_point
private

Referenced by define().

◆ m_max_vertices

constexpr int polygon_::m_max_vertices = 6
staticconstexprprivate

Referenced by add_vertex().

◆ m_num_vertices

int polygon_::m_num_vertices
private

◆ m_sorted

int polygon_::m_sorted
private

Referenced by define().

◆ m_theta

amrex::GpuArray<amrex::Real,m_max_vertices> polygon_::m_theta
private

Referenced by define().

◆ m_vertices

amrex::Array<amrex::RealVect,m_max_vertices> polygon_::m_vertices
private

◆ m_zdir

amrex::RealVect polygon_::m_zdir
private

Referenced by define(), distance(), and normal().


The documentation for this class was generated from the following file: