engine_multiscale_scratchpad.h File Reference

Scratchpad implementation for the MultiscalePartitioningEngineView. More...

#include "gridfire/engine/views/engine_multiscale.h"
#include "gridfire/engine/scratchpads/scratchpad_abstract.h"
#include "gridfire/engine/scratchpads/types.h"
#include "fourdst/atomic/atomicSpecies.h"
#include <vector>
#include <memory>
#include <unordered_map>
#include "sundials/sundials_context.h"

Include dependency graph for engine_multiscale_scratchpad.h:

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

Classes
struct	gridfire::engine::scratch::MultiscalePartitioningEngineViewScratchPad
	Scratchpad for multiscale partitioning engine computations with QSE groups. More...

Namespaces
namespace	gridfire
namespace	gridfire::engine
namespace	gridfire::engine::scratch
	Scratchpad memory management for computational engines.

Detailed Description

Scratchpad implementation for the MultiscalePartitioningEngineView.

This header defines the MultiscalePartitioningEngineViewScratchPad, a concrete implementation of AbstractScratchPad designed for use with multiscale partitioning algorithms. It provides thread-local storage for QSE (Quasi-Static Equilibrium) groups, solvers, species classifications, and SUNDIALS contexts required for solving stiff subsystems.

Purpose

The MultiscalePartitioningEngineViewScratchPad stores:

• QSE groups representing clusters of species in quasi-static equilibrium
• QSE solvers for each group (managed via unique_ptr)
• Classification of species into dynamic vs. algebraic categories
• A composition cache for efficient lookup of computed compositions
• A SUNDIALS context for numerical solver operations

Examples

#include "gridfire/engine/scratchpads/engine_multiscale_scratchpad.h"
 
// Create and initialize the scratchpad
gridfire::engine::scratch::MultiscalePartitioningEngineViewScratchPad scratch;
scratch.initialize();
 
if (scratch.is_initialized()) {
    // Add QSE groups and species classifications
    scratch.dynamic_species.push_back(hydrogen);
    scratch.dynamic_species.push_back(helium);
    scratch.algebraic_species.push_back(carbon);
 
    // Use the SUNDIALS context for solver operations
    SUNContext ctx = scratch.sun_ctx;
}
 
// Clone for parallel execution (note: solvers not cloned)
auto worker_scratch = scratch.clone();
worker_scratch->initialize();  // Must re-initialize for new SUNContext

Thread Safety

This class is not thread-safe. Each thread must have its own instance because SUNDIALS contexts and QSE solvers maintain internal state. When cloning, the QSE solvers are not copied and the SUNContext is not cloned; the new instance must call initialize() to create its own context.

See also

AbstractScratchPad

MultiscalePartitioningEngineView

SUNContext