Abstract class representing an ionic model type. More...

#include <ion_type.h>

Collaboration diagram for limpet::IonType:

Public Types
using	params_type = void
	type of this model's parameter structure More...

using	state_type = void
	type of this model's state variable structure More...

using	private_type = void
	type of this model's private structure More...

using	private_type_vector = void

Public Member Functions
	IonType (std::string name, bool plugin)

const std::string &	get_name () const
	Gets the model name. More...

bool	is_plugin () const
	Returns whether this model is a plugin or not. More...

virtual size_t	params_size () const =0
	Gets the size in bytes needed to represent the parameters of this model. More...

virtual size_t	dlo_vector_size () const =0
	Gets the vector size when using data layout optimization (DLO). More...

virtual uint32_t	reqdat () const =0
	Gets data flags for this IMP's required data. More...

virtual uint32_t	moddat () const =0
	Gets data flags for this IMP's modified data. More...

virtual void	initialize_params (IonIfBase &imp) const =0
	Initializes the parameters in the given IMP. More...

virtual void	construct_tables (IonIfBase &imp) const =0
	Contructs lookup tables. More...

virtual void	destroy (IonIfBase &imp) const =0
	Destroys the given IMP. More...

virtual void	initialize_sv (IonIfBase &imp, GlobalData_t **data) const =0
	Initializes the state variables of the given IMP. More...

virtual Target	select_target (Target target) const =0
	Gets a supported target from the given target. More...

virtual void	compute (Target target, int start, int end, IonIfBase &imp, GlobalData_t **data) const =0
	Performs computation for 1 time step. More...

virtual bool	has_trace () const =0
	Returns whether the trace method is available or not. More...

virtual void	trace (IonIfBase &imp, int node, FILE file, GlobalData_t *data) const =0
	Write the values of traced variables to `file`. More...

virtual void	tune (IonIfBase &imp, const char *im_par) const =0
	Handles setting of this model's parameters. More...

virtual int	read_svs (IonIfBase &imp, FILE *file) const =0
	Reads state variable values for one cell from a file. More...

virtual int	write_svs (IonIfBase &imp, FILE *file, int node) const =0
	Write state variable values for one cell to a file/. More...

virtual SVgetfcn	get_sv_offset (const char svname, int off, int *sz) const =0
	Get the offset and size of a state variable of the model, as well as an access function. More...

virtual int	get_sv_list (char ***list) const =0
	Returns a list of SVs. More...

virtual int	get_sv_type (const char svname, int type, char **type_name) const =0
	Determines the type of a SV. More...

virtual void	print_params () const =0
	Prints the parameters of this model. More...

virtual void	print_metadata () const =0
	Prints the metadata of this model. More...

virtual IonIfBase *	make_ion_if (Target target, int num_node, const std::vector< std::reference_wrapper< IonType >> &plugins) const =0
	Generate an IonIf object from this type. More...

virtual void	destroy_ion_if (IonIfBase *imp) const =0
	Destroy an IonIf object. More...

bool	operator== (const IonType &other) const

bool	operator!= (const IonType &other) const

Detailed Description

Abstract class representing an ionic model type.

This class acts as an interface for ionic models. Each ionic model generated from EasyML or some other language will define this class' abstract functions and used data types.

Definition at line 59 of file ion_type.h.

Member Typedef Documentation

◆ params_type

using limpet::IonType::params_type = void

type of this model's parameter structure

Definition at line 61 of file ion_type.h.

◆ private_type

using limpet::IonType::private_type = void

type of this model's private structure

Definition at line 63 of file ion_type.h.

◆ private_type_vector

using limpet::IonType::private_type_vector = void

Definition at line 64 of file ion_type.h.

◆ state_type

using limpet::IonType::state_type = void

type of this model's state variable structure

Definition at line 62 of file ion_type.h.

Constructor & Destructor Documentation

◆ IonType()

limpet::IonType::IonType	(	std::string	name,
		bool	plugin
	)

inline

Definition at line 70 of file ion_type.h.

Member Function Documentation

◆ compute()

virtual void limpet::IonType::compute	(	Target	target,
		int	start,
		int	end,
		IonIfBase &	imp,
		GlobalData_t **	data
	)		const

pure virtual

Performs computation for 1 time step.

State and private variables of imp will be updated as well as external variables (data) for nodes that are in the start to end range.

Parameters

target	to run the computation on (see limpet::Target)
start	index of the first node (cell) to compute
end	index of the last node (cell) to compute
imp	IMP holding all necessary data
data	external variables

Here is the caller graph for this function:

◆ construct_tables()

virtual void limpet::IonType::construct_tables ( IonIfBase & imp ) const

pure virtual

Contructs lookup tables.

Parameters

imp	IMP structure to constructure the tables in

Here is the caller graph for this function:

◆ destroy()

virtual void limpet::IonType::destroy ( IonIfBase & imp ) const

pure virtual

Destroys the given IMP.

This frees the lookup tables and state variables.

Parameters

imp	IMP to destroy

Here is the caller graph for this function:

◆ destroy_ion_if()

virtual void limpet::IonType::destroy_ion_if ( IonIfBase * imp ) const

pure virtual

Destroy an IonIf object.

Parameters

imp	IMP to destroy

Note: This should only be used to destroy IMPS created with the IonIfBase::make_ion_if function of the same model type

Here is the caller graph for this function:

◆ dlo_vector_size()

virtual size_t limpet::IonType::dlo_vector_size ( ) const

pure virtual

Gets the vector size when using data layout optimization (DLO).

Return values

1	if DLO isn't used (or if vector size is 1)

Returns: the vector size otherwise

Here is the caller graph for this function:

◆ get_name()

const std::string & limpet::IonType::get_name ( ) const

Gets the model name.

Returns: the name of this model

Definition at line 23 of file ion_type.cc.

Here is the caller graph for this function:

◆ get_sv_list()

virtual int limpet::IonType::get_sv_list ( char *** list ) const

pure virtual

Returns a list of SVs.

Parameters

list	list of SVs

Returns: number of SVs

Postcondition: list is allocated and may be freed

Here is the caller graph for this function:

◆ get_sv_offset()

virtual SVgetfcn limpet::IonType::get_sv_offset	(	const char *	svname,
		int *	off,
		int *	sz
	)		const

pure virtual

Get the offset and size of a state variable of the model, as well as an access function.

Parameters

	svname	of the state variable
[out]	off	offset of the variable (or 0 if `svname` is "ALL_SV")
[out]	sz	size of the state variable (or size of the SV structure if `svname` is "ALL_SV"), not the size of the whole sv array in case of DLO e.g. if vector size is 8, sz is still 4 for a float and not 32

Returns: an access fonction that will return a state variable from an offset and a cell number, always as GlobalData_t. (see SVgetfcn)

Here is the caller graph for this function:

◆ get_sv_type()

virtual int limpet::IonType::get_sv_type	(	const char *	svname,
		int *	type,
		char **	type_name
	)		const

pure virtual

Determines the type of a SV.

Parameters

svname	name of the sv
type	type of a sv
type_name	name of the type

Return values

0	the combination imp_id/svname was found
1	the combination imp_id/svname was not found

Here is the caller graph for this function:

◆ has_trace()

virtual bool limpet::IonType::has_trace ( ) const

pure virtual

Returns whether the trace method is available or not.

Returns: true if the trace method is available, or false otherwise

Here is the caller graph for this function:

◆ initialize_params()

virtual void limpet::IonType::initialize_params ( IonIfBase & imp ) const

pure virtual

Initializes the parameters in the given IMP.

Parameters

imp	IMP to initialize the parameters of

Here is the caller graph for this function:

◆ initialize_sv()

virtual void limpet::IonType::initialize_sv	(	IonIfBase &	imp,
		GlobalData_t **	data
	)		const

pure virtual

Initializes the state variables of the given IMP.

Parameters

imp	IMP to initialize the SVs of
data	external variables data (can be written by this functions)

Precondition: data is allocated and initialized

Here is the caller graph for this function:

◆ is_plugin()

bool limpet::IonType::is_plugin ( ) const

Returns whether this model is a plugin or not.

Returns: true if this model is a plugin, or false otherwise

Definition at line 27 of file ion_type.cc.

Here is the caller graph for this function:

◆ make_ion_if()

virtual IonIfBase* limpet::IonType::make_ion_if	(	Target	target,
		int	num_node,
		const std::vector< std::reference_wrapper< IonType >> &	plugins
	)		const

pure virtual

Generate an IonIf object from this type.

Note: The generated instance should always be used with this type only.

Returns: a child class of IonIfBase that is specific to this IonType

Here is the caller graph for this function:

◆ moddat()

virtual uint32_t limpet::IonType::moddat ( ) const

pure virtual

Gets data flags for this IMP's modified data.

Returns: a bitmap of external variables modified by the IMP

Here is the caller graph for this function:

◆ operator!=()

bool limpet::IonType::operator!= ( const IonType & other ) const

Definition at line 35 of file ion_type.cc.

Here is the caller graph for this function:

◆ operator==()

bool limpet::IonType::operator== ( const IonType & other ) const

Definition at line 31 of file ion_type.cc.

Here is the caller graph for this function:

◆ params_size()

virtual size_t limpet::IonType::params_size ( ) const

pure virtual

Gets the size in bytes needed to represent the parameters of this model.

Returns: the size in bytes of the parameters of this model

Here is the caller graph for this function:

◆ print_metadata()

virtual void limpet::IonType::print_metadata ( ) const

pure virtual

Prints the metadata of this model.

Here is the caller graph for this function:

◆ print_params()

virtual void limpet::IonType::print_params ( ) const

pure virtual

Prints the parameters of this model.

Here is the caller graph for this function:

◆ read_svs()

virtual int limpet::IonType::read_svs	(	IonIfBase &	imp,
		FILE *	file
	)		const

pure virtual

Reads state variable values for one cell from a file.

Return values

0	good
1	temporary table allocated
>1	error

Here is the caller graph for this function:

◆ reqdat()

virtual uint32_t limpet::IonType::reqdat ( ) const

pure virtual

Gets data flags for this IMP's required data.

Returns: a bitmap of external variables used but unchanged by the IMP

Here is the caller graph for this function:

◆ select_target()

virtual Target limpet::IonType::select_target ( Target target ) const

pure virtual

Gets a supported target from the given target.

If the given target is Target::AUTO the returned target will be the first available, else for other targets it either returns the same if supported or Target::UNKNOWN.

Parameters

target the given target

Returns: the selected target, or Target::UNKNOWN if the selection failed

Here is the caller graph for this function:

◆ trace()

virtual void limpet::IonType::trace	(	IonIfBase &	imp,
		int	node,
		FILE *	file,
		GlobalData_t **	data
	)		const

pure virtual

Write the values of traced variables to file.

Parameters

imp	IMP holding model data
node	node for which to trace the data
file	file to write to
data	external variables array

Here is the caller graph for this function:

◆ tune()

virtual void limpet::IonType::tune	(	IonIfBase &	imp,
		const char *	im_par
	)		const

pure virtual

Handles setting of this model's parameters.

Parameters

imp	IMP holding this model's data
im_par	string to be parsed for parameter initialization

Here is the caller graph for this function:

◆ write_svs()

virtual int limpet::IonType::write_svs	(	IonIfBase &	imp,
		FILE *	file,
		int	node
	)		const

pure virtual

Write state variable values for one cell to a file/.

Parameters

imp	IMP holding the model's data
out	file to write to
node	number for the cell we want to write the SVs of

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

physics/limpet/src/ion_type.h
physics/limpet/src/ion_type.cc

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ params_type

◆ private_type

◆ private_type_vector

◆ state_type

Constructor & Destructor Documentation

◆ IonType()

Member Function Documentation

◆ compute()

◆ construct_tables()

◆ destroy()

◆ destroy_ion_if()

◆ dlo_vector_size()

◆ get_name()

◆ get_sv_list()

◆ get_sv_offset()

◆ get_sv_type()

◆ has_trace()

◆ initialize_params()

◆ initialize_sv()

◆ is_plugin()

◆ make_ion_if()

◆ moddat()

◆ operator!=()

◆ operator==()

◆ params_size()

◆ print_metadata()

◆ print_params()

◆ read_svs()

◆ reqdat()

◆ select_target()

◆ trace()

◆ tune()

◆ write_svs()