pfc::types::Spacing3 Struct Reference

Represents the spacing of the 3d simulation grid. More...

#include <types.hpp>

Collaboration diagram for pfc::types::Spacing3:

Public Member Functions
	Spacing3 (const std::array< double, 3 > &v)
	Spacing3 (const Size3 &size, const LowerBounds3 &lower, const UpperBounds3 &upper, const Periodic3 &periodic)
	Constructs a Spacing3 object from a Size3, LowerBounds3, UpperBounds3, and Periodic3.

Public Attributes
const std::array< double, 3 >	value

Detailed Description

Represents the spacing of the 3d simulation grid.

Constructor & Destructor Documentation

Spacing3()

pfc::types::Spacing3::Spacing3 ( const Size3 &  size, const LowerBounds3 &  lower, const UpperBounds3 &  upper, const Periodic3 &  periodic  )

inline

Constructs a Spacing3 object from a Size3, LowerBounds3, UpperBounds3, and Periodic3.

Parameters

size	The size of the simulation domain.
lower_bounds	The lower bounds of the simulation domain.
upper_bounds	The upper bounds of the simulation domain.
periodic	The periodicity of the simulation domain.

Returns

The computed spacing.

---

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

• openpfc/core/types.hpp