Source file to read simulation configuration. More...

#include <list>
#include <nlohmann/json.hpp>
#include <stdexcept>
#include <string>
#include "Model.h"
#include "State.h"
#include "debug.h"

Include dependency graph for SimulationParameters.h:

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

Go to the source code of this file.

Classes
struct	SimulationParameters
	Simulation parameters. More...

class	JsonWrapper
	Wrapper class for nlohmann:json with error checking. More...

Functions
int	generate_block (Model &model, const nlohmann::json &block_params_json, const std::string &block_type, const std::string_view &name, bool internal=false, bool periodic=true)
	Generate a new block and add its parameters to the model.

State	load_initial_condition (const nlohmann::json &config, Model &model)
	Load initial conditions from a JSON configuration.

SimulationParameters	load_simulation_params (const nlohmann::json &config)
	Load the simulation parameters from a JSON configuration.

void	load_simulation_model (const nlohmann::json &config, Model &model)
	Load the 0D block in the model from a configuration.

void	validate_input (const nlohmann::json &config)
	Check that the JSON configuration has the required inputs.

void	create_vessels (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component, std::map< int, std::string > &vessel_id_map)
	Handle the creation of vessel blocks and connections with boundary conditions.

void	create_external_coupling (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component, std::map< int, std::string > &vessel_id_map, std::map< std::string, std::string > &bc_type_map)
	Handle the creation of external coupling blocks and connections with other blocks.

void	create_boundary_conditions (Model &model, const nlohmann::json &config, const std::string &component, std::map< std::string, std::string > &bc_type_map, std::vector< std::string > &closed_loop_bcs)
	Handle the creation of boundary condition blocks.

void	create_junctions (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component, std::map< int, std::string > &vessel_id_map)
	Handle the creation of junctions and their connections.

void	create_closed_loop (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component, std::vector< std::string > &closed_loop_bcs)
	Handle the creation of closed-loop blocks and associated connections.

void	create_valves (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component)
	Handle the creation of valves and their associated connections.

void	create_chambers (Model &model, std::vector< std::tuple< std::string, std::string > > &connections, const nlohmann::json &config, const std::string &component)
	Handle the creation of chambers.

Detailed Description

Source file to read simulation configuration.

Function Documentation

◆ create_boundary_conditions()

void create_boundary_conditions	(	Model &	model,
		const nlohmann::json &	config,
		const std::string &	component,
		std::map< std::string, std::string > &	bc_type_map,
		std::vector< std::string > &	closed_loop_bcs )

Handle the creation of boundary condition blocks.

Parameters

model	The model the block is associated with
config	The JSON configuration
component	Name of the component to retrieve from config
bc_type_map	Map between boundary condition names and their types
closed_loop_bcs	List of boundary conditions that should be connected to a closed loop heart block

◆ create_chambers()

void create_chambers	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component )

Handle the creation of chambers.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration containing all the closed loop blocks
component	Name of the component to retrieve from config

◆ create_closed_loop()

void create_closed_loop	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component,
		std::vector< std::string > &	closed_loop_bcs )

Handle the creation of closed-loop blocks and associated connections.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration
component	Name of the component to retrieve from config
closed_loop_bcs	List of boundary conditions that should be connected to a closed loop heart block

< Flag to check if heart block is present (requires different handling)

◆ create_external_coupling()

void create_external_coupling	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component,
		std::map< int, std::string > &	vessel_id_map,
		std::map< std::string, std::string > &	bc_type_map )

Handle the creation of external coupling blocks and connections with other blocks.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration
component	Name of the component to retrieve from config
vessel_id_map	Map between vessel names and IDs
bc_type_map	Map between boundary condition names and their types

◆ create_junctions()

void create_junctions	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component,
		std::map< int, std::string > &	vessel_id_map )

Handle the creation of junctions and their connections.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration
component	Name of the component to retrieve from config
vessel_id_map	Map between vessel names and IDs

◆ create_valves()

void create_valves	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component )

Handle the creation of valves and their associated connections.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration
component	Name of the component to retrieve from config

◆ create_vessels()

void create_vessels	(	Model &	model,
		std::vector< std::tuple< std::string, std::string > > &	connections,
		const nlohmann::json &	config,
		const std::string &	component,
		std::map< int, std::string > &	vessel_id_map )

Handle the creation of vessel blocks and connections with boundary conditions.

Parameters

model	The model the block is associated with
connections	Vector storing the connections between blocks
config	The JSON configuration
component	Name of the component to retrieve from config
vessel_id_map	Map between vessel names and IDs

◆ generate_block()

int generate_block	(	Model &	model,
		const nlohmann::json &	block_params_json,
		const std::string &	block_type,
		const std::string_view &	name,
		bool	internal = false,
		bool	periodic = true )

Generate a new block and add its parameters to the model.

Parameters

model	The model that the block is added to
block_params_json	The JSON configuration containing the block parameter values
block_type	The type of block
name	The name of the block
internal	Is this an internal block? This is relevant for the calibrator
periodic	Is this block periodic with the cardiac cycle? This is relevant for coupling with external solvers

Returns: int The block count

◆ load_initial_condition()

State load_initial_condition	(	const nlohmann::json &	config,
		Model &	model )

Load initial conditions from a JSON configuration.

Parameters

config	The JSON configuration
model	The model

Returns: State Initial configuration for the model

◆ load_simulation_model()

void load_simulation_model	(	const nlohmann::json &	config,
		Model &	model )

Load the 0D block in the model from a configuration.

Parameters

config	The json configuration
model	The 0D model @

◆ load_simulation_params()

SimulationParameters load_simulation_params ( const nlohmann::json & config )

Load the simulation parameters from a JSON configuration.

Parameters

config The JSON configuration

Returns: SimulationParameters Simulation parameters read from configuration

◆ validate_input()

void validate_input ( const nlohmann::json & config )

Check that the JSON configuration has the required inputs.

Parameters

config The JSON configuration

Classes

Functions

Detailed Description

Function Documentation

◆ create_boundary_conditions()

◆ create_chambers()

◆ create_closed_loop()

◆ create_external_coupling()

◆ create_junctions()

◆ create_valves()

◆ create_vessels()

◆ generate_block()

◆ load_initial_condition()

◆ load_simulation_model()

◆ load_simulation_params()

◆ validate_input()