OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
PolarCoordinateSystem Struct Reference

Polar coordinate system parameters. More...

Collaboration diagram for PolarCoordinateSystem:

Public Member Functions

 PolarCoordinateSystem (std::pair< double, double > r_range, std::pair< double, double > theta_range, Bool3 periodic={false, true, false})
 

Public Attributes

const double m_r_min
 Minimum radial distance (typically 0, but can be > 0 for annular domains)
 
const double m_r_max
 Maximum radial distance.
 
const double m_theta_min
 Minimum angle (radians, typically 0)
 
const double m_theta_max
 Maximum angle (radians, typically 2*pi for full circle)
 
const Bool3 m_periodic
 

Detailed Description

Polar coordinate system parameters.

Polar coordinates (r, θ) where:

  • r: radial distance from origin (r ≥ 0)
  • θ: angle measured counter-clockwise from +x axis (radians)

Physical interpretation:

  • x = r * cos(θ)
  • y = r * sin(θ)
  • z = 0 (2D system)

This is a value type (struct) following OpenPFC's "laboratory" philosophy:

  • All members public and const (transparent, inspectable)
  • Immutable after construction (functional style)
  • No methods (operations via free functions)
Examples
/home/runner/work/OpenPFC/OpenPFC/examples/17_custom_coordinate_system.cpp.

Member Data Documentation

◆ m_periodic

const Bool3 PolarCoordinateSystem::m_periodic

Grid periodicity: {radial, angular, unused} Typically {false, true, false} since θ is periodic

Examples
/home/runner/work/OpenPFC/OpenPFC/examples/17_custom_coordinate_system.cpp.

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