fields::field_e3_algebra Namespace Reference

Namespace containing the algrebra functions for a field with a property section of type sec_e3. More...

NON-MEMBER FUNCTIONS OF E3 FACET
void SHEAF_DLL_SPEC	cross (const field_e3 &x0, const field_e3 &x1, field_e3 &xresult, bool xauto_access)
	The 3D Euclidean vector "cross" product of x0 with x1 (pre-allocated version). More...
void SHEAF_DLL_SPEC	cross_equal (field_e3 &xresult, const field_e3 &xother, bool xauto_access)
	The 3D Euclidean vector "cross" product of xresult with xother, /// synonym for cross(xresult, xother, xresult, xauto_access). More...

Detailed Description

Namespace containing the algrebra functions for a field with a property section of type sec_e3.

Function Documentation

cross()

void fields::field_e3_algebra::cross	(	const field_e3 &	x0,
		const field_e3 &	x1,
		field_e3 &	xresult,
		bool	xauto_access
	)

The 3D Euclidean vector "cross" product of x0 with x1 (pre-allocated version).

Implementation for field_e3 algebra functions.

Precondition

• precondition_of(\ cross(x0.property(), x1.property(), xresult.property(), xauto_access))

Postcondition

• postcondition_of(\ cross(x0.property(), x1.property(), xresult.property(), xauto_access))

Definition at line 27 of file field_e3_funcs.impl.h.

References fiber_bundle::sec_e3_algebra::cross(), fiber_bundle::e3_algebra::cross(), cross_equal(), and fields::field_e3::property().

cross_equal()

void fields::field_e3_algebra::cross_equal	(	field_e3 &	xresult,
		const field_e3 &	xother,
		bool	xauto_access
	)

The 3D Euclidean vector "cross" product of xresult with xother, /// synonym for cross(xresult, xother, xresult, xauto_access).

Precondition

• precondition_of(\ cross_equal(xresult.property(), xother.property(), xauto_access))

Postcondition

• postcondition_of(\ cross_equal(xresult.property(), xother.property(), xauto_access))

Definition at line 52 of file field_e3_funcs.impl.h.

References fiber_bundle::sec_e3_algebra::cross_equal(), fiber_bundle::e3_algebra::cross_equal(), and fields::field_e3::property().

Referenced by cross().