OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
pfc::csys::CoordinateSystemDefaults< CoordTag > Struct Template Reference

Trait class for providing default parameters for coordinate systems. More...

Detailed Description

template<typename CoordTag>
struct pfc::csys::CoordinateSystemDefaults< CoordTag >

Trait class for providing default parameters for coordinate systems.

This traits template defines default values (e.g., offset, spacing, periodicity) for coordinate systems identified by their tag type CoordTag.

The primary template is left undefined, and users are expected to specialize this trait for their own coordinate system tags to provide meaningful defaults.

This mechanism allows external extension of coordinate system behavior without modifying the core library, enabling user-defined systems to seamlessly integrate with generic World construction and other infrastructure.

Example specialization:

struct MyCoordTag {};
template <>
static constexpr Real3 offset = {0.0, 0.0, 0.0};
static constexpr Real3 spacing = {1.0, 1.0, 1.0};
static constexpr Bool3 periodicity = {true, false, false};
};
Trait class for providing default parameters for coordinate systems.
Definition csys.hpp:116
Represents the global simulation domain (the "world").
Definition world.hpp:91

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