Fiber::RegularGrid3D Struct Reference

Inheritance diagram for Fiber::RegularGrid3D:

Public Types
typedef MemArrayBase< 3 >	CoordsArray_t
Public Types inherited from Eagle::StrongPtr< Object, ObjectBase >
typedef WeakPtr< Object, ObjectBase >::ObjectBase_t	ObjectBase_t
Public Types inherited from MemCore::WeakPtr< Object, ObjectBase >
typedef Object	object_t
typedef ObjectBase	ObjectBase_t
typedef RefPtrTypeTrait< Object, ObjectBase >::ReferencePointerType	pointer_t
typedef RefPtrTypeTrait< Object, ObjectBase >::ReferenceValueType	refvalue_t
Public Types inherited from MemCore::DynPtr< Object, ObjectBase >
typedef Object	object_t

Public Member Functions
	RegularGrid3D (const RefPtr< Grid > &=NullPtr())
	Request a regular grid from a Grid object.
RegularGrid3D &	operator= (const RefPtr< Grid > &)
	~RegularGrid3D ()
	Destructor.
RefPtr< CoordsArray_t >	getCoords () const
	operator bool () const
Public Member Functions inherited from Eagle::StrongPtr< Object, ObjectBase >
StrongPtr &	assignStrong (const DynPtr_t &other)
StrongPtr &	assignStrong (const ReferenceBase< ObjectBase_t > *Obj)
StrongPtr &	assignStrong (const std::nullptr_t &)
auto	operator() (Arguments...parameters) const -> decltype((*this->getPtrValue())(parameters...))
refvalue_t &	operator* () const
pointer_t	operator-> () const
StrongPtr &	operator= (const DynPtr_t &other)
StrongPtr &	operator= (const ReferenceBase< ObjectBase_t > *Obj)
StrongPtr &	operator= (const std::initializer_list< StrongPtr > &other)
StrongPtr &	operator= (const std::nullptr_t &)
StrongPtr &	operator= (const StrongPtr &other)
auto	operator[] (const IndexType &I) const -> decltype((*this->getPtrValue())[I])
	StrongPtr (const ReferenceBase< ObjectBase_t > *Obj)
	StrongPtr (const ReferenceBase< ObjectBase_t > *Obj, const NotNullPtr &)
	StrongPtr (const std::nullptr_t &)
	StrongPtr (const StrongPtr< ChildObject, ObjectBase > &Other)
	StrongPtr (const StrongPtr< Object, ObjectBase > &Other)
	StrongPtr (const WeakPtr< ChildObject, ObjectBase_t > &Other)
Public Member Functions inherited from MemCore::WeakPtr< Object, ObjectBase >
	WeakPtr (const std::nullptr_t &)
	WeakPtr (const ReferenceBase< ObjectBase > *Obj)
	WeakPtr (const ReferenceBase< ObjectBase > *Obj, const NotNullPtr &)
	WeakPtr (const WeakPtr< AnyObject, ObjectBase > &Other)
	WeakPtr (const WeakPtr &Other)
pointer_t	getPtrValue () const
pointer_t	operator-> () const
refvalue_t &	operator* () const
size_t	operator~ () const
WeakPtr &	assignWeak (const WeakPtr &other)
WeakPtr &	operator= (const WeakPtr &other)
Public Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
const DynPtr &	getDynPtr () const noexcept
const type_info &	getType () const noexcept
bool	isAssignable (const DynPtr< ObjectBase, ObjectBase > &Other) const noexcept
	operator void * () const noexcept
bool	operator! () const noexcept
void	speak (const char *s, const char *prefix="") const noexcept
void	Speak (const char *s, const char *prefix="") const

Static Public Member Functions
static SkeletonID	ID ()
	Return a skeleton ID that is characteristic for this type of Grids.
Static Public Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
static const DynPtr &	getNullPtr () noexcept

Public Attributes
RefPtr< Field >	Positions
	Field for the vertex coordinates.
RefPtr< Representation >	CartesianVertices
	Collection of all fields given on vertices relative to cartesian coordinates.

Additional Inherited Members
Protected Member Functions inherited from MemCore::WeakPtr< Object, ObjectBase >
	WeakPtr (Object *that, const SelfInitialize &)
Protected Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
	DynPtr (const DynPtr< AnyObject, ObjectBase > &Other) noexcept
	DynPtr (const std::nullptr_t &) noexcept

Constructor & Destructor Documentation

RegularGrid3D()

Fiber::RegularGrid3D::RegularGrid3D

(

const RefPtr< Grid > &

G = NullPtr()

)

Request a regular grid from a Grid object.

Note that the Grid pointer (the base class) will not be assigned if the given Grid does not conform to the properties of a Regular Grid, thus the evaluation will return false. A valid code to check if a Grid is regular and 3D looks like this:

RefPtr<Grid> G = ...
        if (RegularGrid3D T = G )
     {
        // yes, it's a regular grid in 3D.
     }

This is a mere meta-data check for the existence of appropriate Fields.

References CartesianVertices, Eagle::StrongPtr< Object, ObjectBase >::operator=(), and Positions.

Member Function Documentation

ID()

SkeletonID Fiber::RegularGrid3D::ID ( )

inlinestatic

Return a skeleton ID that is characteristic for this type of Grids.

In this case, for a set of triangles, it will be the (2,1) skeleton, with 2D cells referring to vertices.