policy_abstract.h File Reference

Abstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions. More...

#include "fourdst/composition/atomicSpecies.h"
#include "gridfire/engine/types/building.h"
#include "gridfire/reaction/reaction.h"
#include "gridfire/engine/engine_abstract.h"
#include <string>
#include <set>

Include dependency graph for policy_abstract.h:

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

Classes
class	gridfire::policy::NetworkPolicy
	Abstract interface for policies that construct DynamicEngine networks from a seed composition. More...
class	gridfire::policy::ReactionChainPolicy
	Abstract interface encapsulating a set of reactions representing a single chain or pathway. More...
class	gridfire::policy::MultiReactionChainPolicy
	A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances. More...

Namespaces
namespace	gridfire
namespace	gridfire::policy

Enumerations
enum class	gridfire::policy::NetworkPolicyStatus {   gridfire::policy::UNINITIALIZED , gridfire::policy::INITIALIZED_UNVERIFIED , gridfire::policy::MISSING_KEY_REACTION , gridfire::policy::MISSING_KEY_SPECIES ,   gridfire::policy::INITIALIZED_VERIFIED }
	Lifecycle/verification status for a NetworkPolicy instance. More...

Detailed Description

Abstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions.

This header declares the base interfaces for high-level "policies" that drive automatic network construction and verification. A NetworkPolicy encapsulates the information required to build a production-ready reaction network from an initial composition (seed species and seed reactions) and to return a constructed DynamicEngine ready for use by the solvers.

Concrete policy implementations live in this directory and provide the real behaviour. See for example:

• gridfire/policy/stellar_policy.h (concrete stellar network policy used in many examples)
• gridfire/policy/chains.h (reaction-chain helper policies such as proton-proton, CNO)

An example of using a concrete policy to construct and run an engine is available at:

• tests/graphnet_sandbox/main.cpp

Note

Doxygen comments on public methods include

Example usage blocks. Methods that may

throw in concrete implementations include

Exceptions

tags.