openpfc.hpp File Reference

Main convenience header that includes all OpenPFC public API components. More...

#include "array.hpp"
#include "binary_reader.hpp"
#include "boundary_conditions/fixed_bc.hpp"
#include "boundary_conditions/moving_bc.hpp"
#include "constants.hpp"
#include "core/decomposition.hpp"
#include "core/world.hpp"
#include "discrete_field.hpp"
#include "factory/decomposition_factory.hpp"
#include "fft.hpp"
#include "field_modifier.hpp"
#include "initial_conditions/constant.hpp"
#include "initial_conditions/file_reader.hpp"
#include "initial_conditions/random_seeds.hpp"
#include "initial_conditions/seed.hpp"
#include "initial_conditions/seed_grid.hpp"
#include "initial_conditions/single_seed.hpp"
#include "model.hpp"
#include "mpi.hpp"
#include "multi_index.hpp"
#include "results_writer.hpp"
#include "simulator.hpp"
#include "time.hpp"
#include "types.hpp"
#include "utils.hpp"
#include "utils/show.hpp"

Include dependency graph for openpfc.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Detailed Description

Main convenience header that includes all OpenPFC public API components.

This is the primary include file for OpenPFC users. Including this single header provides access to all public API components:

• Core infrastructure (World, Decomposition, FFT)
• Physics models (Model base class)
• Simulation orchestration (Simulator, Time)
• Initial conditions (Constant, Seed, FileReader, RandomSeeds, SeedGrid, etc.)
• Boundary conditions (FixedBC, MovingBC)
• I/O (ResultsWriter, BinaryReader)
• Utilities (Array, MultiIndex, DiscreteField, utils)

Most users should start with this header for maximum convenience:

#include <openpfc/openpfc.hpp>
 
int main(int argc, char** argv) {
    pfc::mpi::Environment env(argc, argv);
    // Your simulation code here
}

For faster compilation times, advanced users can include specific headers:

#include <openpfc/core/world.hpp>
#include <openpfc/model.hpp>
#include <openpfc/simulator.hpp>

This file is part of the Core API module, serving as the main entry point for all OpenPFC functionality.

See also

core/world.hpp for computational domain setup

model.hpp for physics model implementation

simulator.hpp for running simulations

docs/getting_started/ for tutorials and examples

Author

OpenPFC Contributors

Date

2025