shammodels::basegodunov::modules::ResidualDot< T > Class Template Reference

Inheritance diagram for shammodels::basegodunov::modules::ResidualDot< T >:

Collaboration diagram for shammodels::basegodunov::modules::ResidualDot< T >:

Classes
struct	Edges

Public Member Functions
void	set_edges (std::shared_ptr< shamrock::solvergraph::IFieldRefs< T > > spans_phi_res, std::shared_ptr< shamrock::solvergraph::ScalarEdge< Tscal > > res_ddot)
Edges	get_edges ()
void	_impl_evaluate_internal ()
	evaluate the node
virtual std::string	_impl_get_label () const
	get the label of the node
virtual std::string	_impl_get_tex () const
	get the tex of the node
Public Member Functions inherited from shamrock::solvergraph::INode
	INode (const INode &)=delete
INode &	operator= (const INode &)=delete
	would violate shared_from_this() & unique UUID
	INode (INode &&) noexcept=default
	would violate shared_from_this() & unique UUID
INode &	operator= (INode &&) noexcept=default
	Move assignment - automatically delegates to base classes and members.
std::shared_ptr< INode >	getptr_shared ()
	Get a shared pointer to this node.
std::weak_ptr< INode >	getptr_weak ()
	Get a weak pointer to this node.
std::vector< std::shared_ptr< IEdge > > &	get_ro_edges ()
	Get the read only edges.
std::vector< std::shared_ptr< IEdge > > &	get_rw_edges ()
	Get the read write edges.
void	__internal_set_ro_edges (std::vector< std::shared_ptr< IEdge > > new_ro_edges)
	Set the read only edges.
void	__internal_set_rw_edges (std::vector< std::shared_ptr< IEdge > > new_rw_edges)
	Set the read write edges.
template<class Func >
void	on_edge_ro_edges (Func &&f)
	Apply a function to the read only edges.
template<class Func >
void	on_edge_rw_edges (Func &&f)
	Apply a function to the read write edges.
virtual	~INode ()
	Destructor (virtual) & reset the edges.
template<class T >
const T &	get_ro_edge (int slot)
	Get a read only edge and cast it to the type T.
template<class T >
T &	get_rw_edge (int slot)
	Get a read write edge and cast it to the type T.
const IEdge &	get_ro_edge_base (int slot)
	Get a reference to a read only edge.
const IEdge &	get_ro_edge_base (int slot) const
IEdge &	get_rw_edge_base (int slot)
	Get a reference to a read write edge and cast it to the type IEdge.
const IEdge &	get_rw_edge_base (int slot) const
void	evaluate ()
	Evaluate the node.
std::string	get_dot_graph ()
	Get the dot graph of the node (Currently only an alias to get_dot_graph_partial)
std::string	get_dot_graph_partial ()
	Get the dot graph of the subgraph corresponding to the node.
std::string	get_dot_graph_node_start ()
	Get the id of the node start in the dot graph.
std::string	get_dot_graph_node_end ()
	Get the id of the node end in the dot graph.
std::string	get_tex ()
	Get the TeX of the node.
std::string	get_tex_partial ()
	Get the TeX of the node partial.
virtual std::string	print_node_info () const
	print the node info
Public Member Functions inherited from shambase::WithUUID< INode, u64 >
u64	get_uuid () const
	Get the uuid of the class.
	WithUUID ()
	Constructor of the class.

Additional Inherited Members
Protected Member Functions inherited from shamrock::solvergraph::INode
virtual std::string	_impl_get_dot_graph_partial () const
	get the dot graph of the node partial
virtual std::string	_impl_get_dot_graph_node_start () const
	get the dot graph of the node start
virtual std::string	_impl_get_dot_graph_node_end () const
	get the dot graph of the node end
Protected Attributes inherited from shambase::WithUUID< INode, u64 >
u64	uuid
	The unique identifier of the class.

Detailed Description

template<class T>
class shammodels::basegodunov::modules::ResidualDot< T >

Definition at line 27 of file ResidualDot.hpp.

Constructor & Destructor Documentation

ResidualDot()

template<class T >

shammodels::basegodunov::modules::ResidualDot< T >::ResidualDot ( )

inline

Definition at line 31 of file ResidualDot.hpp.

Member Function Documentation

_impl_evaluate_internal()

template<class T >

void shammodels::basegodunov::modules::ResidualDot< T >::_impl_evaluate_internal ( )

virtual

evaluate the node

Implements shamrock::solvergraph::INode.

Definition at line 25 of file ResidualDot.cpp.

_impl_get_label()

template<class T >

virtual std::string shammodels::basegodunov::modules::ResidualDot< T >::_impl_get_label ( ) const

inlinevirtual

get the label of the node

Implements shamrock::solvergraph::INode.

Definition at line 54 of file ResidualDot.hpp.

_impl_get_tex()

template<class T >

std::string shammodels::basegodunov::modules::ResidualDot< T >::_impl_get_tex ( ) const

virtual

get the tex of the node

Implements shamrock::solvergraph::INode.

Definition at line 37 of file ResidualDot.cpp.

Here is the call graph for this function:

get_edges()

template<class T >

Edges shammodels::basegodunov::modules::ResidualDot< T >::get_edges ( )

inline

Definition at line 45 of file ResidualDot.hpp.

set_edges()

template<class T >

void shammodels::basegodunov::modules::ResidualDot< T >::set_edges ( std::shared_ptr< shamrock::solvergraph::IFieldRefs< T > >  spans_phi_res, std::shared_ptr< shamrock::solvergraph::ScalarEdge< Tscal > >  res_ddot  )

inline

Definition at line 38 of file ResidualDot.hpp.

---

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

• shammodels/ramses/include/shammodels/ramses/modules/ResidualDot.hpp
• shammodels/ramses/src/modules/ResidualDot.cpp