OpenPFC/world__factory_8hpp_source.html

// SPDX-FileCopyrightText: 2025 VTT Technical Research Centre of Finland Ltd

// SPDX-License-Identifier: AGPL-3.0-or-later


#pragma once


#include "csys.hpp"

#include "strong_types.hpp"

#include "types.hpp"

#include "world.hpp"


namespace pfc {

namespace world {


using pfc::csys::CartesianTag;

using pfc::csys::CoordinateSystem;

using pfc::types::Int3;

using pfc::types::Real3;


CartesianWorld create(const Int3 &size);


CartesianWorld create(const GridSize &size, const PhysicalOrigin &origin,

                      const GridSpacing &spacing);


[[deprecated("Use create(GridSize, PhysicalOrigin, GridSpacing) for type safety. "

             "See migration guide in documentation.")]] CartesianWorld

create(const Int3 &size, const Real3 &offset, const Real3 &spacing);


} // namespace world

} // namespace pfc

pfc::types::Int3
std::array< int, 3 > Int3
Type aliases for clarity.
Definition types.hpp:45

csys.hpp
Extensible coordinate system framework.

pfc::world::create
auto create(const World< T > &world, const heffte::box3d< int > &box)
Construct a new World object from an existing one and a box.
Definition decomposition.hpp:62

strong_types.hpp
Strong type aliases for geometric quantities.

pfc::GridSize
Grid dimensions (number of grid points per dimension)
Definition strong_types.hpp:176

pfc::GridSpacing
Physical spacing between grid points.
Definition strong_types.hpp:370

pfc::PhysicalOrigin
Physical origin of coordinate system.
Definition strong_types.hpp:424

pfc::csys::CartesianTag
Tag type for the 3D Cartesian coordinate system.
Definition csys.hpp:147

pfc::csys::CoordinateSystem
Primary template for defining coordinate systems by tag.
Definition csys.hpp:87

pfc::world::World
Represents the global simulation domain (the "world").
Definition world.hpp:91

types.hpp
Common type aliases used throughout OpenPFC.

world.hpp
World class definition and unified interface.