A section evaluator using trilinear interpolation over a cubic 3D domain. Intended for use with uniform meshes. More...

#include <uniform_3d.h>

Inheritance diagram for fiber_bundle::uniform_3d:

UNIFORM_3D FACET
	uniform_3d ()
	Default constructor. More...

	uniform_3d (const uniform_3d &xother)
	Copy constructor. More...

virtual	~uniform_3d ()
	Destructor. More...

LINEAR_FCN_SPACE FACET
Todo: Fix!
virtual int	dl () const
	The dimension of this function space. More...

virtual void	basis_at_coord (const dof_type xlocal_coord[], size_type xlocal_coord_ub)
	Computes the value of each basis function at local coordinates xlocal_coord. More...

virtual void	basis_derivs_at_coord (const dof_type xlocal_coords[], size_type xlocal_coords_ub)
	Computes the value of the derivatives of each basis function at local coordinates xlocal_coords. More...

INTEGRABLE_SECTION_EVALUATOR FACET
virtual value_type	jacobian_determinant (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const coord_type xlocal_coords[], size_type xlocal_coords_ub)
	Computes the the determinant of the jacobian matrix at local coordinates xlocal_coords with coordinate dofs xcoord_dofs. More...

virtual value_type	volume (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf)
	Volume for specified coordinate dofs xcoord_dofs and fiber space dimension xdf. More...

virtual void	integrate (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const dof_type xintegrands[], size_type xintegrands_ub, value_type xresult_integrals[], size_type xresult_integrals_ub)
	Computes the value of the integral of the integrand array... More...

virtual void	integrate (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const dof_type xintegrand, value_type xresult_integrals[], size_type xresult_integrals_ub)
	Computes the value of the integral of the integrand... More...

virtual void	gauss_point (pod_index_type xindex, coord_type xresult[], size_type xresult_ub)
	The local coordinates of the gauss point with index xindex. More...

DIFFERENTIABLE_SECTION_EVALUATOR FACET
void	dxi_local (size_type xlocal_coord_index, const dof_type xsource_dofs[], size_type xsource_dofs_ub, dof_type xresult_dofs[], size_type xresult_dofs_ub) const
	First partial derivative of this with respect to local coordinate xlocal_coord_index. More...

virtual void	jacobian (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const dof_type xlocal_coords[], size_type xlocal_coords_ub)
	Computes the the jacobian matrix at local coordinates xlocal_coords with coordinate dofs xcoord_dofs. More...

DOMAIN FACET
virtual int	db () const
	The base dimension; the dimension of the local coordinates (independent variable). More...

virtual void	local_coordinates (pod_index_type xindex, coord_type xresult[], size_type xresult_ub) const
	The local coordinates of the dof with local index xindex. More...

virtual bool	in_standard_domain (const dof_type xlocal_coords[], size_type xlocal_coords_ub) const
	Return true if the specified local coordinates are in the "standard" domain; otherwise return false. More...

EVALUATION FACET
virtual void	coord_at_value (const dof_type xdofs[], size_type xdofs_ub, const dof_type xglobal_coords[], size_type xglobal_coord_ub, dof_type xlocal_coords[], size_type xlocal_coords_ub) const
	The local coordinates of a point at which the field has the value xvalue. The dofs are assumed to be interleaved (x0, y0, z0, x1, y1, z1, ...). More...

ANY FACET
virtual uniform_3d *	clone () const
	Virtual constructor, creates a new instance of the same type as this. More...

virtual uniform_3d &	operator= (const section_evaluator &xother)
	Assignment operator. More...

uniform_3d &	operator= (const uniform_3d &xother)
	Assignment operator. More...

virtual bool	invariant () const
	Class invariant. More...

virtual bool	is_ancestor_of (const any *xother) const
	Conformance test; true if other conforms to this. More...

Additional Inherited Members
Public Types inherited from fiber_bundle::section_evaluator
typedef chart_point_coord_type	coord_type
	The type of local coordinate; the scalar type for the local coordinate vector space. More...

typedef vd_value_type	value_type
	The type of component in the value; the scalar type in the range vector space. More...

typedef sec_vd_dof_type	dof_type
	The type of degree of freedom. More...

Public Member Functions inherited from fiber_bundle::linear_fcn_space
	linear_fcn_space (const linear_fcn_space &xother)
	Copy constructor. More...

virtual	~linear_fcn_space ()
	Destructor. More...

const value_type *	basis_values () const
	The result of the preceding call to basis_at_coord. More...

const value_type *	basis_deriv_values () const
	The result of the preceding call to basis_derivs_at_coord. More...

virtual size_type	dof_ct () const
	The number of dofs required for each component of the dependent variable. More...

virtual void	value_at_coord (const dof_type xdofs[], size_type xdofs_ub, const dof_type xlocal_coords[], size_type xlocal_coords_ub, dof_type xresult[], size_type xresult_ub) const
	Computes the value of the function at local coordinates xlocal_coords using the degrees of freedom xdofs. More...

linear_fcn_space &	operator= (const linear_fcn_space &xother)
	Assignment operator. More...

Public Member Functions inherited from fiber_bundle::integrable_section_evaluator
	integrable_section_evaluator (const integrable_section_evaluator &xother)
	Copy constructor. More...

virtual	~integrable_section_evaluator ()
	Destructor. More...

virtual void	integrate (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const dof_type xintegrands[], size_type xintegrands_ub, value_type xresult_integrals[], size_type xresult_integrals_ub)=0
	Computes the value of the integral of the integrand array... More...

virtual void	integrate (const dof_type xcoord_dofs[], size_type xcoord_dofs_ub, size_type xdf, const dof_type xintegrand, value_type xresult_integrals[], size_type xresult_integrals_ub)
	Computes the value of the integral of the integrand... More...

virtual integrable_section_evaluator &	operator= (const integrable_section_evaluator &xother)
	Assignment operator. More...

Public Member Functions inherited from fiber_bundle::differentiable_section_evaluator
	differentiable_section_evaluator (const differentiable_section_evaluator &xother)
	Copy constructor. More...

virtual	~differentiable_section_evaluator ()
	Destructor. More...

void	dxi_local (size_type xlocal_coord_index, const block< dof_type > &xsource_dofs, block< dof_type > &xresult_dofs) const
	First partial derivative of this with respect to local coordinate xlocal_coord_index. More...

const value_type *	jacobian_values () const
	The result of the preceding call to jacobian. More...

virtual differentiable_section_evaluator &	operator= (const differentiable_section_evaluator &xother)
	Assignment operator. More...

Public Member Functions inherited from fiber_bundle::section_evaluator
	section_evaluator (const section_evaluator &xother)
	Copy constructor. More...

virtual	~section_evaluator ()
	Destructor. More...

void	local_coordinates (pod_index_type xindex, block< coord_type > &xresult) const
	The local coordinates of the dof with local index xindex. More...

virtual void	center (coord_type xresult[], size_type xresult_ub) const
	The local coordinates at the center of the evaluator. More...

void	center (block< coord_type > &xresult) const
	The local coordinates at the center of the evaluator. More...

bool	in_standard_domain (const block< dof_type > &xlocal_coords) const
	True if the specified local coordinates are in the "standard" domain. More...

bool	df_is_variable () const
	True if and only if the fiber dimension (number of components of the dependent variable) is variable. More...

virtual int	df () const
	The fiber dimension (number of components of dependent variable). More...

virtual dof_type	value_at_coord (const dof_type xdofs[], size_type xdofs_ub, const dof_type xlocal_coords[], size_type xlocal_coords_ub) const
	Value at a specified local_coordinate. Single component version. More...

dof_type	value_at_coord (const block< dof_type > &xdofs, const block< dof_type > &xlocal_coords) const
	Value at a specified local_coordinate. Single component version. More...

void	value_at_coord (const block< dof_type > &xdofs, const block< dof_type > &xlocal_coords, block< dof_type > &xresult) const
	Values at a specified local_coordinate. Multiple component version. More...

void	coord_at_value (const block< dof_type > &xdofs, const block< dof_type > &xvalue, block< dof_type > &xlocal_coords) const
	The local coordinates of a point at which the field has the value xvalue. The dofs are assumed to be interleaved. More...

virtual dof_type	min (const dof_type xdofs[], size_type xdofs_ub) const
	The minimum value of the scalar or component section defined by xdofs. More...

dof_type	min (const block< dof_type > &xdofs) const
	The minimum value of the scalar or component section defined by xdofs. More...

virtual void	min (const dof_type xdofs[], size_type xdofs_ub, dof_type xresult[], size_type xresult_ub) const
	The minimum value of the vector section defined by xdofs. More...

void	min (const block< dof_type > &xdofs, block< dof_type > &xresult) const
	The minimum value of the vector section defined by xdofs. More...

virtual dof_type	max (const dof_type xdofs[], size_type xdofs_ub) const
	The maximum value of the scalar or component section defined by xdofs. More...

dof_type	max (const block< dof_type > &xdofs) const
	The maximum value of the scalar or component section defined by xdofs. More...

virtual void	max (const dof_type xdofs[], size_type xdofs_ub, dof_type xresult[], size_type xresult_ub) const
	The maximum value of the vector section defined by xdofs. More...

void	max (const block< dof_type > &xdofs, block< dof_type > &xresult) const
	The maximum value of the vector section defined by xdofs. More...

Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...

virtual	~any ()
	Destructor. More...

bool	invariant_check () const
	True if invariant checking is enabled. More...

void	enable_invariant_check () const
	Enable invariant checking. More...

void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...

int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...

Protected Member Functions inherited from fiber_bundle::linear_fcn_space
	linear_fcn_space ()
	Default constructor. More...

Protected Member Functions inherited from fiber_bundle::integrable_section_evaluator
	integrable_section_evaluator ()
	Default constructor. More...

Protected Member Functions inherited from fiber_bundle::differentiable_section_evaluator
	differentiable_section_evaluator ()
	Default constructor. More...

Protected Member Functions inherited from fiber_bundle::section_evaluator
	section_evaluator ()
	Default constructor. More...

Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Protected Attributes inherited from fiber_bundle::linear_fcn_space
value_type *	_basis_values
	The result of the preceding call to basis_at_coord. More...

value_type *	_basis_deriv_values
	The result of the preceding call to basis_derivs_at_coord. More...

Protected Attributes inherited from fiber_bundle::differentiable_section_evaluator
value_type *	_jacobian_values
	The result of the preceding call to "jacobian". More...

Detailed Description

A section evaluator using trilinear interpolation over a cubic 3D domain. Intended for use with uniform meshes.

Definition at line 39 of file uniform_3d.h.

Constructor & Destructor Documentation

◆ uniform_3d() [1/2]

fiber_bundle::uniform_3d::uniform_3d ( )

Default constructor.

Postcondition

invariant()

Definition at line 33 of file uniform_3d.cc.

◆ uniform_3d() [2/2]

fiber_bundle::uniform_3d::uniform_3d ( const uniform_3d & xother )

Copy constructor.

Postcondition

invariant()

Definition at line 53 of file uniform_3d.cc.

References ~uniform_3d().

◆ ~uniform_3d()

fiber_bundle::uniform_3d::~uniform_3d ( )

virtual

Destructor.

Postcondition

invariant()

Definition at line 73 of file uniform_3d.cc.

References dl().

Referenced by uniform_3d().

Member Function Documentation

◆ basis_at_coord()

void fiber_bundle::uniform_3d::basis_at_coord	(	const dof_type	xlocal_coord[],
		size_type	xlocal_coord_ub
	)

virtual

Computes the value of each basis function at local coordinates xlocal_coord.

Precondition

xlocal_coord != 0

xlocal_coord_ub >= 3

Postcondition

invariant()

Implements fiber_bundle::linear_fcn_space.

Definition at line 116 of file uniform_3d.cc.

References basis_derivs_at_coord().

Referenced by dl().

◆ basis_derivs_at_coord()

void fiber_bundle::uniform_3d::basis_derivs_at_coord	(	const dof_type	xlocal_coords[],
		size_type	xlocal_coords_ub
	)

virtual

Computes the value of the derivatives of each basis function at local coordinates xlocal_coords.

Precondition

xlocal_coords != 0

xlocal_coords_ub >= db()

basis_deriv_values() != 0

Postcondition

invariant()

Implements fiber_bundle::linear_fcn_space.

Definition at line 151 of file uniform_3d.cc.

Referenced by basis_at_coord().

◆ clone()

fiber_bundle::uniform_3d * fiber_bundle::uniform_3d::clone ( ) const

virtual

Virtual constructor, creates a new instance of the same type as this.

Postcondition

result != 0

is_same_type(result)

result->invariant()

Implements fiber_bundle::linear_fcn_space.

Definition at line 704 of file uniform_3d.cc.

References invariant(), and operator=().

Referenced by coord_at_value().

◆ coord_at_value()

void fiber_bundle::uniform_3d::coord_at_value	(	const dof_type	xdofs[],
		size_type	xdofs_ub,
		const dof_type	xglobal_coords[],
		size_type	xglobal_coord_ub,
		dof_type	xlocal_coords[],
		size_type	xlocal_coords_ub
	)		const

virtual

The local coordinates of a point at which the field has the value xvalue. The dofs are assumed to be interleaved (x0, y0, z0, x1, y1, z1, ...).

Precondition

xdofs != 0

xdofs_ub >= 24

xglobal_coords != 0

xglobal_coord_ub >= 3

xlocal_coords != 0

xlocal_coords_ub >= 3

Postcondition

invariant()

Implements fiber_bundle::section_evaluator.

Definition at line 617 of file uniform_3d.cc.

References clone().

Referenced by in_standard_domain().

◆ db()

int fiber_bundle::uniform_3d::db ( ) const

virtual

The base dimension; the dimension of the local coordinates (independent variable).

Postcondition

result == 3

Implements fiber_bundle::section_evaluator.

Definition at line 513 of file uniform_3d.cc.

References local_coordinates().

Referenced by jacobian().

◆ dl()

int fiber_bundle::uniform_3d::dl ( ) const

virtual

The dimension of this function space.

Postcondition

result == 8

Implements fiber_bundle::linear_fcn_space.

Definition at line 93 of file uniform_3d.cc.

References basis_at_coord().

Referenced by ~uniform_3d().

◆ dxi_local()

void fiber_bundle::uniform_3d::dxi_local	(	size_type	xlocal_coord_index,
		const dof_type	xsource_dofs[],
		size_type	xsource_dofs_ub,
		dof_type	xresult_dofs[],
		size_type	xresult_dofs_ub
	)		const

virtual

First partial derivative of this with respect to local coordinate xlocal_coord_index.

Precondition

xlocal_coord_index < db()

xsource_dofs != 0

xsource_dofs_ub >= 24

xresult_dofs != 0

Todo:: implement.

Not Implemented.

Implements fiber_bundle::differentiable_section_evaluator.

Definition at line 412 of file uniform_3d.cc.

References jacobian().

Referenced by gauss_point().

◆ gauss_point()

void fiber_bundle::uniform_3d::gauss_point	(	pod_index_type	xindex,
		coord_type	xresult[],
		size_type	xresult_ub
	)

virtual

The local coordinates of the gauss point with index xindex.

Precondition

(0 <= xindex) && (xindex < dof_ct())

xresult_ub >= db()

Not Implemented.

Todo:: Implement.

Postcondition

in_standard_domain(xresult, xresult_ub)

invariant()

Implements fiber_bundle::integrable_section_evaluator.

Definition at line 380 of file uniform_3d.cc.

References dxi_local().

Referenced by volume().

◆ in_standard_domain()

bool fiber_bundle::uniform_3d::in_standard_domain	(	const dof_type	xlocal_coords[],
		size_type	xlocal_coords_ub
	)		const

virtual

Return true if the specified local coordinates are in the "standard" domain; otherwise return false.

Precondition

xlocal_coords != 0

xlocal_coords_ub >= 3

Implements fiber_bundle::section_evaluator.

Definition at line 578 of file uniform_3d.cc.

References coord_at_value().

Referenced by local_coordinates().

◆ integrate() [1/2]

virtual void fiber_bundle::uniform_3d::integrate	(	const dof_type	xcoord_dofs[],
		size_type	xcoord_dofs_ub,
		size_type	xdf,
		const dof_type	xintegrands[],
		size_type	xintegrands_ub,
		value_type	xresult_integrals[],
		size_type	xresult_integrals_ub
	)

virtual

Computes the value of the integral of the integrand array...

Referenced by volume().

◆ integrate() [2/2]

virtual void fiber_bundle::uniform_3d::integrate	(	const dof_type	xcoord_dofs[],
		size_type	xcoord_dofs_ub,
		size_type	xdf,
		const dof_type	xintegrand,
		value_type	xresult_integrals[],
		size_type	xresult_integrals_ub
	)

virtual

Computes the value of the integral of the integrand...

◆ invariant()

bool fiber_bundle::uniform_3d::invariant ( ) const

virtual

Class invariant.

Invariant

basis_values() != 0

Reimplemented from fiber_bundle::linear_fcn_space.

Definition at line 771 of file uniform_3d.cc.

References is_ancestor_of().

Referenced by clone(), and operator=().

◆ is_ancestor_of()

bool fiber_bundle::uniform_3d::is_ancestor_of ( const any * xother ) const

virtual

Conformance test; true if other conforms to this.

Precondition

xother != 0

Reimplemented from fiber_bundle::linear_fcn_space.

Definition at line 804 of file uniform_3d.cc.

Referenced by invariant().

◆ jacobian()

void fiber_bundle::uniform_3d::jacobian	(	const dof_type	xcoord_dofs[],
		size_type	xcoord_dofs_ub,
		size_type	xdf,
		const dof_type	xlocal_coords[],
		size_type	xlocal_coords_ub
	)

virtual

Computes the the jacobian matrix at local coordinates xlocal_coords with coordinate dofs xcoord_dofs.

Precondition

xcoord_dofs != 0

xcoord_dofs_ub >= db()*dl()

xlocal_coords != 0

xlocal_coords_ub >= db()

jacobian_values() != 0

Not Implemented.

Todo:: Implement.

Postcondition

invariant()

Reimplemented from fiber_bundle::differentiable_section_evaluator.

Definition at line 477 of file uniform_3d.cc.

References db().

Referenced by dxi_local().

◆ jacobian_determinant()

fiber_bundle::section_evaluator::value_type fiber_bundle::uniform_3d::jacobian_determinant	(	const dof_type	xcoord_dofs[],
		size_type	xcoord_dofs_ub,
		size_type	xdf,
		const coord_type	xlocal_coords[],
		size_type	xlocal_coords_ub
	)

virtual

Computes the the determinant of the jacobian matrix at local coordinates xlocal_coords with coordinate dofs xcoord_dofs.

Precondition

xcoord_dofs != 0

xcoord_dofs_ub >= db()*dl()

xlocal_coords != 0

xlocal_coords_ub >= db()

Not Implemented.

Todo:: Implement.

Postcondition

invariant()

Reimplemented from fiber_bundle::differentiable_section_evaluator.

Definition at line 246 of file uniform_3d.cc.

References volume().

◆ local_coordinates()

void fiber_bundle::uniform_3d::local_coordinates	(	pod_index_type	xindex,
		coord_type	xresult[],
		size_type	xresult_ub
	)		const

virtual

The local coordinates of the dof with local index xindex.

Precondition

(0 <= xindex) && (xindex < dof_ct())

xresult_ub >= db()

Postcondition

in_standard_domain(xresult, xresult_ub)

Implements fiber_bundle::section_evaluator.

Definition at line 537 of file uniform_3d.cc.

References in_standard_domain().

Referenced by db().

◆ operator=() [1/2]

fiber_bundle::uniform_3d & fiber_bundle::uniform_3d::operator= ( const section_evaluator & xother )

virtual

Assignment operator.

Precondition

is_ancestor_of(&xother)

Not Implemented.

Postcondition

invariant()

Reimplemented from fiber_bundle::linear_fcn_space.

Definition at line 728 of file uniform_3d.cc.

Referenced by clone().

◆ operator=() [2/2]

fiber_bundle::uniform_3d & fiber_bundle::uniform_3d::operator= ( const uniform_3d & xother )

Assignment operator.

Precondition

is_ancestor_of(&xother)

Not Implemented.

Postcondition

invariant()

Definition at line 748 of file uniform_3d.cc.

References invariant().

◆ volume()

fiber_bundle::section_evaluator::value_type fiber_bundle::uniform_3d::volume	(	const dof_type	xcoord_dofs[],
		size_type	xcoord_dofs_ub,
		size_type	xdf
	)

virtual

Volume for specified coordinate dofs xcoord_dofs and fiber space dimension xdf.

Precondition

xcoord_dofs != 0

xcoord_dofs_ub >= dl()*db()

xdf == 2 || xdf == 2 || xdf == 3

Todo:: Implement.

Not Implemented.

Postcondition

invariant()

Implements fiber_bundle::integrable_section_evaluator.

Definition at line 280 of file uniform_3d.cc.

References gauss_point(), and integrate().

Referenced by jacobian_determinant().

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

UNIFORM_3D FACET

LINEAR_FCN_SPACE FACET

INTEGRABLE_SECTION_EVALUATOR FACET

DIFFERENTIABLE_SECTION_EVALUATOR FACET

DOMAIN FACET

EVALUATION FACET

ANY FACET

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ uniform_3d() [1/2]

◆ uniform_3d() [2/2]

◆ ~uniform_3d()

Member Function Documentation

◆ basis_at_coord()

◆ basis_derivs_at_coord()

◆ clone()

◆ coord_at_value()

◆ db()

◆ dl()

◆ dxi_local()

◆ gauss_point()

◆ in_standard_domain()

◆ integrate() [1/2]

◆ integrate() [2/2]

◆ invariant()

◆ is_ancestor_of()

◆ jacobian()

◆ jacobian_determinant()

◆ local_coordinates()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ volume()