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

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

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

Public Member Functions
	Field (u32 nvar, std::string name, std::string texsymbol)
virtual DDPatchDataFieldRef< T > &	get_refs ()
	Get the DistributedData of PatchDataFieldRefs.
virtual const DDPatchDataFieldRef< T > &	get_refs () const
	Const variant of get_refs.
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.
shambase::DistributedData< u32 >	get_obj_cnts () const
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).
virtual void	free_alloc ()
	Free allocated memory.
ComputeField< T >	extract ()
sham::DeviceBuffer< T > &	get_buf (u64 id_patch)
PatchDataField< T > &	get (u64 id_patch)
const PatchDataField< T > &	get (u64 id_patch) const
u32	get_nvar () const
Public Member Functions inherited from shamrock::solvergraph::IFieldRefs< T >
PatchDataField< T > &	get_field (u64 id) const
	Get the underlying PatchDataField at the given id.
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::Field< T >

Definition at line 27 of file Field.hpp.

Constructor & Destructor Documentation

Field()

template<class T >

shamrock::solvergraph::Field< T >::Field ( u32  nvar, std::string  name, std::string  texsymbol  )

inline

Definition at line 51 of file Field.hpp.

Member Function Documentation

check_sizes()

template<class T >

virtual void shamrock::solvergraph::Field< 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 64 of file Field.hpp.

ensure_sizes()

template<class T >

virtual void shamrock::solvergraph::Field< 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 92 of file Field.hpp.

extract()

template<class T >

ComputeField< T > shamrock::solvergraph::Field< T >::extract ( )

inline

Definition at line 124 of file Field.hpp.

free_alloc()

template<class T >

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

inlinevirtual

Free allocated memory.

Implements shamrock::solvergraph::IFreeable.

Definition at line 122 of file Field.hpp.

get() [1/2]

template<class T >

PatchDataField< T > & shamrock::solvergraph::Field< T >::get ( u64  id_patch )

inline

Definition at line 130 of file Field.hpp.

get() [2/2]

template<class T >

const PatchDataField< T > & shamrock::solvergraph::Field< T >::get ( u64  id_patch ) const

inline

Definition at line 131 of file Field.hpp.

get_buf()

template<class T >

sham::DeviceBuffer< T > & shamrock::solvergraph::Field< T >::get_buf ( u64  id_patch )

inline

Definition at line 126 of file Field.hpp.

get_nvar()

template<class T >

u32 shamrock::solvergraph::Field< T >::get_nvar ( ) const

inline

Definition at line 135 of file Field.hpp.

get_obj_cnts()

template<class T >

shambase::DistributedData< u32 > shamrock::solvergraph::Field< T >::get_obj_cnts ( ) const

inline

Definition at line 62 of file Field.hpp.

get_refs() [1/2]

template<class T >

virtual DDPatchDataFieldRef< T > & shamrock::solvergraph::Field< T >::get_refs ( )

inlinevirtual

Get the DistributedData of PatchDataFieldRefs.

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

Definition at line 54 of file Field.hpp.

get_refs() [2/2]

template<class T >

virtual const DDPatchDataFieldRef< T > & shamrock::solvergraph::Field< T >::get_refs ( ) const

inlinevirtual

Const variant of get_refs.

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

Definition at line 56 of file Field.hpp.

get_spans() [1/2]

template<class T >

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

inlinevirtual

Get the DistributedData of spans attached to the underlying field.

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

Definition at line 58 of file Field.hpp.

get_spans() [2/2]

template<class T >

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

inlinevirtual

Const variant of get_spans.

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

Definition at line 60 of file Field.hpp.

---

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

• shamrock/include/shamrock/solvergraph/Field.hpp