shamrock::solvergraph::FieldSpan< T > Class Template Reference

Inheritance diagram for shamrock::solvergraph::FieldSpan< T >:

Collaboration diagram for shamrock::solvergraph::FieldSpan< T >:

Public Member Functions
virtual DDPatchDataFieldSpanPointer< T > &	get_spans ()
	Get the DistributedData of spans attached to the underlying field.
virtual const DDPatchDataFieldSpanPointer< T > &	get_spans () const
	Const variant of get_spans.
virtual void	check_sizes (const shambase::DistributedData< u32 > &sizes) const
	Check that the sizes of the patches in the field match the given sizes.
virtual void	ensure_sizes (const shambase::DistributedData< u32 > &sizes)
	Ensure that the sizes of the patches in the field match the given sizes (Can resize the underlying fields).
void	set_spans (DDPatchDataFieldSpanPointer< T > spans)
DDPatchDataFieldSpanPointer< T >	extract ()
virtual void	free_alloc ()
	Free allocated memory.
Public Member Functions inherited from shamrock::solvergraph::IFieldSpan< T >
	IEdgeNamed (std::string name, std::string texsymbol)
Public Member Functions inherited from shamrock::solvergraph::IEdgeNamed
	IEdgeNamed (std::string name, std::string texsymbol)
virtual std::string	_impl_get_dot_label () const
virtual std::string	_impl_get_tex_symbol () const
Public Member Functions inherited from shamrock::solvergraph::IEdge
std::string	get_label () const
std::string	get_tex_symbol () const
Public Member Functions inherited from shambase::WithUUID< IEdge, u64 >
u64	get_uuid () const
	Get the uuid of the class.
	WithUUID ()
	Constructor of the class.
Public Member Functions inherited from shamrock::solvergraph::IFreeable
virtual	~IFreeable ()
	Virtual destructor.

Additional Inherited Members
Protected Attributes inherited from shambase::WithUUID< IEdge, u64 >
u64	uuid
	The unique identifier of the class.

Detailed Description

template<class T>
class shamrock::solvergraph::FieldSpan< T >

Definition at line 27 of file FieldSpan.hpp.

Member Function Documentation

check_sizes()

template<class T >

virtual void shamrock::solvergraph::FieldSpan< T >::check_sizes ( const shambase::DistributedData< u32 > &  sizes ) const

inlinevirtual

Check that the sizes of the patches in the field match the given sizes.

Parameters

sizes

the expected sizes

Implements shamrock::solvergraph::IFieldSpan< T >.

Definition at line 38 of file FieldSpan.hpp.

Here is the call graph for this function:

ensure_sizes()

template<class T >

virtual void shamrock::solvergraph::FieldSpan< T >::ensure_sizes ( const shambase::DistributedData< u32 > &  sizes )

inlinevirtual

Ensure that the sizes of the patches in the field match the given sizes (Can resize the underlying fields).

Parameters

sizes

the expected sizes

Implements shamrock::solvergraph::IFieldSpan< T >.

Definition at line 69 of file FieldSpan.hpp.

Here is the call graph for this function:

extract()

template<class T >

DDPatchDataFieldSpanPointer< T > shamrock::solvergraph::FieldSpan< T >::extract ( )

inline

Definition at line 75 of file FieldSpan.hpp.

free_alloc()

template<class T >

virtual void shamrock::solvergraph::FieldSpan< T >::free_alloc ( )

inlinevirtual

Free allocated memory.

Implements shamrock::solvergraph::IFreeable.

Definition at line 80 of file FieldSpan.hpp.

get_spans() [1/2]

template<class T >

virtual DDPatchDataFieldSpanPointer< T > & shamrock::solvergraph::FieldSpan< T >::get_spans ( )

inlinevirtual

Get the DistributedData of spans attached to the underlying field.

Implements shamrock::solvergraph::IFieldSpan< T >.

Definition at line 34 of file FieldSpan.hpp.

get_spans() [2/2]

template<class T >

virtual const DDPatchDataFieldSpanPointer< T > & shamrock::solvergraph::FieldSpan< T >::get_spans ( ) const

inlinevirtual

Const variant of get_spans.

Implements shamrock::solvergraph::IFieldSpan< T >.

Definition at line 36 of file FieldSpan.hpp.

set_spans()

template<class T >

void shamrock::solvergraph::FieldSpan< T >::set_spans ( DDPatchDataFieldSpanPointer< T >  spans )

inline

Definition at line 73 of file FieldSpan.hpp.

---

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

• shamrock/include/shamrock/solvergraph/FieldSpan.hpp