smith::SystemBase Struct Reference

Base struct for physics systems containing common members and helper functions. More...

#include <system_base.hpp>

Public Member Functions
const std::vector< FieldState > &	getParameterFields () const
	Get the list of all parameter fields. More...
std::string	prefix (const std::string &name) const
	Helper function to prepend the physics name to a string. More...
std::vector< ReactionInfo >	getReactionInfos () const
	Metadata for dual outputs exported by this system.

Public Attributes
std::shared_ptr< FieldStore >	field_store
	Field store managing the system's fields.
std::shared_ptr< CoupledSystemSolver >	solver
	The solver for the system.
std::shared_ptr< StateAdvancer >	advancer
	The state advancer.
std::vector< FieldState >	parameter_fields
	Optional parameter fields.
std::string	prepend_name
	Optional prepended name for all fields.

Detailed Description

Base struct for physics systems containing common members and helper functions.

Definition at line 60 of file system_base.hpp.

Member Function Documentation

getParameterFields()

const std::vector<FieldState>& smith::SystemBase::getParameterFields ( ) const

inline

Get the list of all parameter fields.

Returns

const std::vector<FieldState>& List of parameter fields.

Definition at line 71 of file system_base.hpp.

prefix()

std::string smith::SystemBase::prefix ( const std::string &  name ) const

inline

Helper function to prepend the physics name to a string.

Parameters

name	The name to prepend to.

Returns

std::string The prepended name.

Definition at line 78 of file system_base.hpp.

---

The documentation for this struct was generated from the following file:

• src/smith/differentiable_numerics/system_base.hpp