OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
types.hpp File Reference

Common type aliases used throughout OpenPFC. More...

#include <array>
#include <complex>
#include <unordered_map>
#include <vector>
Include dependency graph for types.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

template<class T >
using pfc::Vec3 = std::array< T, 3 >
 
using pfc::Field = std::vector< double >
 
using pfc::RealField = std::vector< double >
 
using pfc::RealFieldSet = std::unordered_map< std::string, RealField & >
 
using pfc::ComplexField = std::vector< std::complex< double > >
 
using pfc::ComplexFieldSet = std::unordered_map< std::string, ComplexField & >
 

Detailed Description

Common type aliases used throughout OpenPFC.

This file defines standard type aliases for field data and containers:

  • Field: std::vector<double> for real-valued field data
  • RealField: Alias for Field
  • ComplexField: std::vector<std::complex<double>> for Fourier space data
  • RealFieldSet: Map of named real fields
  • ComplexFieldSet: Map of named complex fields
  • Vec3<T>: 3D vector (std::array<T, 3>)

These aliases provide consistent types across the codebase and simplify template instantiations.

See also
model.hpp for field management
array.hpp for multi-dimensional arrays
Author
OpenPFC Contributors
Date
2025