Abstract patch function base class. More...

#include </home/runner/work/iganet/iganet/include/iganet/splines/patch.hpp>

Public Types
using	value_type = real_t
	Scalar type.

Public Member Functions
virtual	~BSplinePatch ()=default
	Destructor.

virtual torch::Tensor	as_tensor () const noexcept=0
	Provides the `as_tensor` operation.

virtual int64_t	as_tensor_size () const noexcept=0
	Returns the size of the single tensor representation of all coefficients.

virtual torch::Device	device () const noexcept=0
	Returns the `device` property.

virtual int32_t	device_index () const noexcept=0
	Returns the `device_index` property.

virtual torch::Dtype	dtype () const noexcept=0
	Returns the `dtype` property.

virtual BSplinePatch &	from_json (const nlohmann::json &json)=0
	Updates the B-spline patch from a JSON object.

virtual BSplinePatch &	from_tensor (const torch::Tensor &tensor) noexcept=0
	Sets all coefficients from a single tensor.

virtual BSplinePatch &	from_xml (const pugi::xml_document &doc, int id=0, const std::string &label="", int index=-1)=0
	Updates the B-spline patch from an XML document.

virtual BSplinePatch &	from_xml (const pugi::xml_node &root, int id=0, const std::string &label="", int index=-1)=0
	Updates the B-spline patch from an XML node.

virtual bool	is_sparse () const noexcept=0
	Returns if the layout is sparse.

virtual torch::Layout	layout () const noexcept=0
	Returns the `layout` property.

virtual bool	pinned_memory () const noexcept=0
	Returns the `pinned_memory` property.

virtual void	pretty_print (std::ostream &os=Log(log::info)) const noexcept=0
	Returns a string representation.

virtual bool	requires_grad () const noexcept=0
	Returns the `requires_grad` property.

virtual BSplinePatch &	set_requires_grad (bool requires_grad) noexcept=0
	Sets the B-spline object's `requires_grad` property.

virtual nlohmann::json	to_json () const =0
	Returns the B-spline patch as a JSON object.

virtual pugi::xml_document	to_xml (int id=0, const std::string &label="", int index=-1) const =0
	Returns the B-spline patch as an XML document.

virtual pugi::xml_node &	to_xml (pugi::xml_node &root, int id=0, const std::string &label="", int index=-1) const =0
	Appends the B-spline patch to an XML node.

Static Public Member Functions
static constexpr short_t	geoDim () noexcept
	Dimension of the physical space.

static constexpr short_t	parDim () noexcept
	Dimension of the parametric space.

Detailed Description

template<typename real_t, short_t GeoDim, short_t ParDim>
class iganet::BSplinePatch< real_t, GeoDim, ParDim >

Abstract patch function base class.

Member Typedef Documentation

◆ value_type

template<typename real_t , short_t GeoDim, short_t ParDim>

using iganet::BSplinePatch< real_t, GeoDim, ParDim >::value_type = real_t

Scalar type.

Constructor & Destructor Documentation

◆ ~BSplinePatch()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual iganet::BSplinePatch< real_t, GeoDim, ParDim >::~BSplinePatch ( )

virtualdefault

Destructor.

Member Function Documentation

◆ as_tensor()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual torch::Tensor iganet::BSplinePatch< real_t, GeoDim, ParDim >::as_tensor ( ) const

pure virtualnoexcept

Provides the as_tensor operation.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ as_tensor_size()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual int64_t iganet::BSplinePatch< real_t, GeoDim, ParDim >::as_tensor_size ( ) const

pure virtualnoexcept

Returns the size of the single tensor representation of all coefficients.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ device()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual torch::Device iganet::BSplinePatch< real_t, GeoDim, ParDim >::device ( ) const

pure virtualnoexcept

Returns the device property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ device_index()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual int32_t iganet::BSplinePatch< real_t, GeoDim, ParDim >::device_index ( ) const

pure virtualnoexcept

Returns the device_index property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ dtype()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual torch::Dtype iganet::BSplinePatch< real_t, GeoDim, ParDim >::dtype ( ) const

pure virtualnoexcept

Returns the dtype property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ eval_from_precomputed() [1/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual utils::BlockTensor< torch::Tensor, 1, GeoDim > iganet::BSplinePatch< real_t, GeoDim, ParDim >::eval_from_precomputed	(	const torch::Tensor &	basfunc,
		const torch::Tensor &	coeff_indices,
		int64_t	numeval,
		torch::IntArrayRef	sizes
	)		const

pure virtual

Returns the value of the spline function from precomputed basis function.

Parameters

basfunc	Value of `basfunc`.
coeff_indices	Value of `coeff_indices`.
numeval	Value of `numeval`.
sizes	Value of `sizes`.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ eval_from_precomputed() [2/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual utils::BlockTensor< torch::Tensor, 1, GeoDim > iganet::BSplinePatch< real_t, GeoDim, ParDim >::eval_from_precomputed	(	const utils::TensorArray< ParDim > &	basfunc,
		const torch::Tensor &	coeff_indices,
		int64_t	numeval,
		torch::IntArrayRef	sizes
	)		const

pure virtual

Provides the eval_from_precomputed operation.

Parameters

basfunc	Value of `basfunc`.
coeff_indices	Value of `coeff_indices`.
numeval	Value of `numeval`.
sizes	Value of `sizes`.

Returns: Result of the operation.

◆ from_json()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual BSplinePatch & iganet::BSplinePatch< real_t, GeoDim, ParDim >::from_json ( const nlohmann::json & json )

pure virtual

Updates the B-spline patch from a JSON object.

Parameters

json	JSON value to process.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ from_tensor()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual BSplinePatch & iganet::BSplinePatch< real_t, GeoDim, ParDim >::from_tensor ( const torch::Tensor & tensor )

pure virtualnoexcept

Sets all coefficients from a single tensor.

Parameters

tensor Tensor to process.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ from_xml() [1/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual BSplinePatch & iganet::BSplinePatch< real_t, GeoDim, ParDim >::from_xml	(	const pugi::xml_document &	doc,
		int	id = `0`,
		const std::string &	label = `""`,
		int	index = `-1`
	)

pure virtual

Updates the B-spline patch from an XML document.

Parameters

doc	Value of `doc`.
id	Object identifier.
label	Object label.
index	Object index.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ from_xml() [2/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual BSplinePatch & iganet::BSplinePatch< real_t, GeoDim, ParDim >::from_xml	(	const pugi::xml_node &	root,
		int	id = `0`,
		const std::string &	label = `""`,
		int	index = `-1`
	)

pure virtual

Updates the B-spline patch from an XML node.

Parameters

root	Root XML node.
id	Object identifier.
label	Object label.
index	Object index.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ geoDim()

template<typename real_t , short_t GeoDim, short_t ParDim>

static constexpr short_t iganet::BSplinePatch< real_t, GeoDim, ParDim >::geoDim ( )

inlinestaticconstexprnoexcept

Dimension of the physical space.

Returns: Result of the operation.

◆ is_sparse()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual bool iganet::BSplinePatch< real_t, GeoDim, ParDim >::is_sparse ( ) const

pure virtualnoexcept

Returns if the layout is sparse.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ layout()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual torch::Layout iganet::BSplinePatch< real_t, GeoDim, ParDim >::layout ( ) const

pure virtualnoexcept

Returns the layout property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ parDim()

template<typename real_t , short_t GeoDim, short_t ParDim>

static constexpr short_t iganet::BSplinePatch< real_t, GeoDim, ParDim >::parDim ( )

inlinestaticconstexprnoexcept

Dimension of the parametric space.

Returns: Result of the operation.

◆ pinned_memory()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual bool iganet::BSplinePatch< real_t, GeoDim, ParDim >::pinned_memory ( ) const

pure virtualnoexcept

Returns the pinned_memory property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ pretty_print()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual void iganet::BSplinePatch< real_t, GeoDim, ParDim >::pretty_print ( std::ostream & os = Log(log::info) ) const

pure virtualnoexcept

Returns a string representation.

Parameters

os	Output stream.

◆ requires_grad()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual bool iganet::BSplinePatch< real_t, GeoDim, ParDim >::requires_grad ( ) const

pure virtualnoexcept

Returns the requires_grad property.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ set_requires_grad()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual BSplinePatch & iganet::BSplinePatch< real_t, GeoDim, ParDim >::set_requires_grad ( bool requires_grad )

pure virtualnoexcept

Sets the B-spline object's requires_grad property.

Parameters

requires_grad Value of requires_grad.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ to_json()

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual nlohmann::json iganet::BSplinePatch< real_t, GeoDim, ParDim >::to_json ( ) const

pure virtual

Returns the B-spline patch as a JSON object.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ to_xml() [1/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual pugi::xml_document iganet::BSplinePatch< real_t, GeoDim, ParDim >::to_xml	(	int	id = `0`,
		const std::string &	label = `""`,
		int	index = `-1`
	)		const

pure virtual

Returns the B-spline patch as an XML document.

Parameters

id	Object identifier.
label	Object label.
index	Object index.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

◆ to_xml() [2/2]

template<typename real_t , short_t GeoDim, short_t ParDim>

virtual pugi::xml_node & iganet::BSplinePatch< real_t, GeoDim, ParDim >::to_xml	(	pugi::xml_node &	root,
		int	id = `0`,
		const std::string &	label = `""`,
		int	index = `-1`
	)		const

pure virtual

Appends the B-spline patch to an XML node.

Parameters

root	Root XML node.
id	Object identifier.
label	Object label.
index	Object index.

Returns: Result of the operation.

Implemented in iganet::UniformBSplineCore< real_t, GeoDim, Degrees >, iganet::UniformBSplineCore< real_t, GeoDim+1, Degrees... >, and iganet::UniformBSplineCore< real_t, GeoDim, Degrees... >.

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

include/iganet/splines/patch.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ ~BSplinePatch()

Member Function Documentation

◆ as_tensor()

◆ as_tensor_size()

◆ device()

◆ device_index()

◆ dtype()

◆ eval_from_precomputed() [1/2]

◆ eval_from_precomputed() [2/2]

◆ from_json()

◆ from_tensor()

◆ from_xml() [1/2]

◆ from_xml() [2/2]

◆ geoDim()

◆ is_sparse()

◆ layout()

◆ parDim()

◆ pinned_memory()

◆ pretty_print()

◆ requires_grad()

◆ set_requires_grad()

◆ to_json()

◆ to_xml() [1/2]

◆ to_xml() [2/2]