A metric tensor over a 1 dimensional Euclidean vector space (volatile version). More...

#include <met_e3.h>

Inheritance diagram for fiber_bundle::met_e3_lite:

EUCLIDEAN METRIC 3D (MET_E3) FACET OF CLASS MET_E3_LITE
typedef met_e3_row_dofs_type< double >	row_dofs_type
	The type of the row dofs. More...

typedef e3_lite	vector_space_type
	Type of underlying vector space. More...

typedef met_e3_row_dofs_type< double >::matrix_type	matrix_type
	The type of the associated matrix. More...

row_dofs_type	_row_dofs
	Row_dofs_type. More...

	met_e3_lite ()
	Default constructor. More...

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

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

virtual	~met_e3_lite ()
	Destructor. More...

	met_e3_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

met_e3_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from a row dofs type) operator. More...

	met_e3_lite (const matrix_type &xmatrix)
	Creates a new instance with matrix type xmatrix. More...

met_e3_lite &	operator= (const matrix_type &xmatrix)
	Assignment (from a matrix type) operator. More...

	operator matrix_type & ()
	Conversion (cast) operator to convert to the associated matrix type (non const version). More...

	operator const matrix_type & () const
	Conversion (cast) operator to convert to the associated matrix type (const version). More...

	operator row_dofs_type & ()
	Conversion (cast) operator to convert to the associated row dofs type (non const version). More...

	operator const row_dofs_type & () const
	Conversion (cast) operator to convert to the associated row dofs type (const version). More...

	met_e3_lite (const value_type &xx_comp, const value_type &xy_comp, const value_type &xz_comp, const value_type &yy_comp, const value_type &yz_comp, const value_type &zz_comp)
	Creates a new instance with row dofs xx_comp, xy_comp, xz_comp, yy_comp, yz_comp, zz_comp. More...

virtual void	put_components (const value_type &xx_comp, const value_type &xy_comp, const value_type &xz_comp, const value_type &yy_comp, const value_type &yz_comp, const value_type &zz_comp)

TENSOR ALGEBRA (TP) FACET OF CLASS MET_E3_LITE
virtual int	dd () const
	Dimension of the underlying vector space. More...

VECTOR ALGEBRA (VD) FACET OF CLASS MET_E3_LITE
virtual const tp_lite &	tp_prototype (int xp) const
	Prototype for general tensors of degree xp over this vector space. More...

virtual const atp_lite &	atp_prototype (int xp) const
	Prototype for antisymmetric tensors of degree xp over this vector space. More...

virtual const stp_lite &	stp_prototype (int xp) const
	Prototype for symmetric tensors of degree xp over this vector space. More...

ABSTRACT POSET MEMBER FACET OF CLASS MET_E3_LITE
virtual const std::string &	class_name () const
	The name of this class. More...

virtual met_e3_lite *	clone () const
	Virtual constructor, makes a new instance of the same type as this. More...

virtual met_e3_lite *	clone (bool xnew_state, bool xauto_access) const
	Virtual constructor, makes a new instance of the same type as this; synonym for clone(), intended for use only in certain templates. More...

static const std::string &	static_class_name ()
	The name of this class. More...

ANY FACET OF CLASS MET_E3_LITE
virtual bool	is_ancestor_of (const any_lite &xother) const
	Conformance test; true if other conforms to this. More...

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

virtual void *	row_dofs ()
	The row dofs for this instance (mutable version). More...

virtual const void *	row_dofs () const
	The row dofs for this instance (const version). More...

Additional Inherited Members
Public Types inherited from fiber_bundle::st2_lite
enum	static_const_int { P = 2 }
	The tensor degree (static version) More...

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

Public Types inherited from fiber_bundle::tp_lite
enum	static_const_int { P = -1 }
	The degree of this tensor space. More...

typedef tp_table_dofs_type	table_dofs_type
	The type of the table dofs. More...

typedef vd_lite	vector_space_type
	Type of underlying vector space. More...

Public Types inherited from fiber_bundle::vd_lite
typedef vd_dof_type	dof_type
	The type of the degrees of freedom. More...

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

typedef vd_table_dofs_type	table_dofs_type
	The type of the table dofs. More...

typedef vd_row_dofs_type< double >	row_dofs_type
	The type of the row dofs. More...

Public Types inherited from fiber_bundle::tuple_lite
typedef tuple_table_dofs_type	table_dofs_type
	The type of the table dofs. More...

Public Types inherited from fiber_bundle::any_lite
typedef any_lite	volatile_type
	The associated volatile type. More...

Public Member Functions inherited from fiber_bundle::met_ed_lite
	met_ed_lite ()
	Default constructor. More...

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

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

virtual	~met_ed_lite ()
	Destructor. More...

	met_ed_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

met_ed_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from row_dofs_type) operator. More...

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

Public Member Functions inherited from fiber_bundle::met_lite
	met_lite ()
	Default constructor. More...

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

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

virtual	~met_lite ()
	Destructor. More...

	met_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

met_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from row_dofs_type) operator. More...

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

Public Member Functions inherited from fiber_bundle::st2_lite
virtual int	p () const
	Degree of this as an antisymmetric tensor space. More...

	st2_lite ()
	Default constructor. More...

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

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

virtual	~st2_lite ()
	Destructor. More...

	st2_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

st2_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from row_dofs_type) operator. More...

virtual value_type	component (int xrow, int xcolumn) const
	The value of the component in a specified row and column. More...

virtual void	put_component (int xrow, int xcolumn, value_type xcomp)
	Sets value of a component in a specified row and column. More...

virtual int	index_for_row_column (int xrow, int xcolumn) const
	The index into linear storage of the component in a specified row and column. More...

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

Public Member Functions inherited from fiber_bundle::stp_lite
	stp_lite ()
	Default constructor. More...

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

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

virtual	~stp_lite ()
	Destructor. More...

	stp_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

stp_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from row_dofs_type) operator. More...

virtual int	d () const
	Dimension of this as a vector space. More...

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

Public Member Functions inherited from fiber_bundle::tp_lite
	tp_lite ()
	Default constructor. More...

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

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

virtual	~tp_lite ()
	Destructor. More...

	tp_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

tp_lite &	operator= (const row_dofs_type &xrow_dofs)
	Assignment (from row_dofs_type) operator. More...

virtual pod_index_type	vector_space_index () const
	Index of the underlying vector space. More...

table_dofs_type	table_dofs () const
	The table dofs. More...

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

Public Member Functions inherited from fiber_bundle::vd_lite
	vd_lite ()
	Default constructor. More...

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

vd_lite &	operator= (const vd_lite &xother)
	Copy assignment operator. More...

bool	operator== (const vd_lite &xother) const
	True if this has the same components as xother. More...

virtual	~vd_lite ()
	Destructor. More...

	vd_lite (const row_dofs_type &xrow_dofs)
	Creates a new instance with row dofs xrow_dofs. More...

vd_lite &	operator= (const row_dofs_type &xrow_dofs)
	Row_dofs_type assignment operator. More...

value_type	component (int xindex) const
	The xindex-th component. More...

void	put_component (int xindex, value_type xcomp)
	Set the xindex-th component to xcomp. More...

virtual void	components (dof_type xresult[], int comps_dimension) const
	The values of all the components (preallocated version). More...

virtual void	put_components (const dof_type xcomps[], int xcomps_dimension)
	Set values of all the components to the values in xcomps. More...

vd_lite &	operator= (const value_type &xvalue)
	Value_type assignment operator; sets all components to xvalue. More...

bool	operator== (const value_type &xvalue) const
	Equality comparison to scalar; true if and only if all components == xvalue. Especially useful for comparison to 0.0. More...

virtual value_type &	operator[] (int xindex)
	The value of the component corresponding to xindex (non const version). More...

virtual const value_type &	operator[] (int xindex) const
	The value of the component corresponding to xindex (const version). More...

virtual int	factor_ct () const
	Number of factors (components) in tuple. More...

table_dofs_type	table_dofs () const
	The table dofs. More...

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

Public Member Functions inherited from fiber_bundle::tuple_lite
	tuple_lite ()
	Default constructor. More...

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

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

virtual	~tuple_lite ()
	Destructor. More...

table_dofs_type	table_dofs () const
	The table dofs. More...

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

Public Member Functions inherited from fiber_bundle::any_lite
virtual	~any_lite ()
	Destructor. More...

bool	is_same_type (const any_lite &xother) const
	True if other is the same type as this. More...

bool	invariant () const
	Class invariant, intended to be redefined in each descendant. 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...

Static Public Member Functions inherited from fiber_bundle::met_ed_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::met_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::st2_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::stp_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::tp_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::vd_lite
static const tp_lite &	static_tp_prototype (int xp)
	Static prototype for general tensors of degree xp over this vector space. More...

static const atp_lite &	static_atp_prototype (int xp)
	Static prototype for antisymmetric tensors of degree xp over this vector space. More...

static const stp_lite &	static_stp_prototype (int xp)
	Static prototype for symmetric tensors of degree xp over this vector space. More...

static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::tuple_lite
static const std::string &	static_class_name ()
	The name of this class. More...

Static Public Member Functions inherited from fiber_bundle::any_lite
static const std::string &	static_class_name ()
	The name of this class. More...

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

Detailed Description

A metric tensor over a 1 dimensional Euclidean vector space (volatile version).

Definition at line 145 of file met_e3.h.

Member Typedef Documentation

◆ matrix_type

typedef met_e3_row_dofs_type<double>::matrix_type fiber_bundle::met_e3_lite::matrix_type

The type of the associated matrix.

Definition at line 169 of file met_e3.h.

◆ row_dofs_type

typedef met_e3_row_dofs_type<double> fiber_bundle::met_e3_lite::row_dofs_type

The type of the row dofs.

Definition at line 159 of file met_e3.h.

◆ vector_space_type

typedef e3_lite fiber_bundle::met_e3_lite::vector_space_type

Type of underlying vector space.

Definition at line 164 of file met_e3.h.

Constructor & Destructor Documentation

◆ met_e3_lite() [1/5]

fiber_bundle::met_e3_lite::met_e3_lite ( )

Default constructor.

Postcondition

invariant()

Definition at line 53 of file met_e3.cc.

Referenced by operator const row_dofs_type &(), operator=(), and ~met_e3_lite().

◆ met_e3_lite() [2/5]

fiber_bundle::met_e3_lite::met_e3_lite ( const met_e3_lite & xother )

Copy constructor.

Postcondition

invariant()

Definition at line 67 of file met_e3.cc.

References operator=().

◆ ~met_e3_lite()

fiber_bundle::met_e3_lite::~met_e3_lite ( )

virtual

Destructor.

Definition at line 107 of file met_e3.cc.

References met_e3_lite().

Referenced by operator=().

◆ met_e3_lite() [3/5]

fiber_bundle::met_e3_lite::met_e3_lite ( const row_dofs_type & xrow_dofs )

Creates a new instance with row dofs xrow_dofs.

Postcondition

invariant()

Definition at line 120 of file met_e3.cc.

References operator=().

◆ met_e3_lite() [4/5]

fiber_bundle::met_e3_lite::met_e3_lite ( const matrix_type & xmatrix )

Creates a new instance with matrix type xmatrix.

Postcondition

invariant()

Definition at line 156 of file met_e3.cc.

References operator=().

◆ met_e3_lite() [5/5]

fiber_bundle::met_e3_lite::met_e3_lite	(	const value_type &	xx_comp,
		const value_type &	xy_comp,
		const value_type &	xz_comp,
		const value_type &	yy_comp,
		const value_type &	yz_comp,
		const value_type &	zz_comp
	)

Creates a new instance with row dofs xx_comp, xy_comp, xz_comp, yy_comp, yz_comp, zz_comp.

Postcondition

invariant()

isunordered_or_equals(component(0), xx_comp)

isunordered_or_equals(component(1), xy_comp)

isunordered_or_equals(component(2), xz_comp)

isunordered_or_equals(component(3), yy_comp)

isunordered_or_equals(component(4), yz_comp)

isunordered_or_equals(component(5), zz_comp)

Definition at line 257 of file met_e3.cc.

References sheaf::isunordered_or_equals(), and put_components().

Member Function Documentation

◆ atp_prototype()

const fiber_bundle::atp_lite & fiber_bundle::met_e3_lite::atp_prototype ( int xp ) const

virtual

Prototype for antisymmetric tensors of degree xp over this vector space.

Precondition

precondition_of(e3_lite::static_atp_prototype(xp))

Postcondition

postcondition_of(e3_lite::static_atp_prototype(xp))

Reimplemented from fiber_bundle::vd_lite.

Definition at line 426 of file met_e3.cc.

References stp_prototype().

Referenced by tp_prototype().

◆ class_name()

const std::string & fiber_bundle::met_e3_lite::class_name ( ) const

virtual

The name of this class.

Postcondition

!result.empty()

Reimplemented from fiber_bundle::met_ed_lite.

Definition at line 490 of file met_e3.cc.

References static_class_name().

Referenced by stp_prototype().

◆ clone() [1/2]

fiber_bundle::met_e3_lite * fiber_bundle::met_e3_lite::clone ( ) const

virtual

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

Postcondition

result != 0

is_same_type(*result)

Reimplemented from fiber_bundle::met_ed_lite.

Definition at line 528 of file met_e3.cc.

Referenced by static_class_name().

◆ clone() [2/2]

virtual met_e3_lite* fiber_bundle::met_e3_lite::clone	(	bool	xnew_state,
		bool	xauto_access
	)		const

inlinevirtual

Virtual constructor, makes a new instance of the same type as this; synonym for clone(), intended for use only in certain templates.

Definition at line 408 of file met_e3.h.

References fiber_bundle::met_e3_row_dofs_type< T >::clone(), and sheaf::row_dofs().

◆ dd()

int fiber_bundle::met_e3_lite::dd ( ) const

virtual

Dimension of the underlying vector space.

Postcondition

invariant()

result == 3

Reimplemented from fiber_bundle::tp_lite.

Definition at line 374 of file met_e3.cc.

References tp_prototype().

Referenced by put_components().

◆ invariant()

bool fiber_bundle::met_e3_lite::invariant ( ) const

Class invariant.

Invariant

met_ed_lite::invariant()

Definition at line 580 of file met_e3.cc.

References row_dofs().

Referenced by is_ancestor_of().

◆ is_ancestor_of()

bool fiber_bundle::met_e3_lite::is_ancestor_of ( const any_lite & xother ) const

virtual

Conformance test; true if other conforms to this.

Precondition

&xother != 0

Reimplemented from fiber_bundle::met_ed_lite.

Definition at line 561 of file met_e3.cc.

References invariant().

◆ operator const matrix_type &()

fiber_bundle::met_e3_lite::operator const met_e3_lite::matrix_type & ( ) const

Conversion (cast) operator to convert to the associated matrix type (const version).

Definition at line 209 of file met_e3.cc.

◆ operator const row_dofs_type &()

fiber_bundle::met_e3_lite::operator const met_e3_lite::row_dofs_type & ( ) const

Conversion (cast) operator to convert to the associated row dofs type (const version).

Definition at line 241 of file met_e3.cc.

References met_e3_lite().

◆ operator matrix_type &()

fiber_bundle::met_e3_lite::operator met_e3_lite::matrix_type & ( )

Conversion (cast) operator to convert to the associated matrix type (non const version).

Definition at line 193 of file met_e3.cc.

◆ operator row_dofs_type &()

fiber_bundle::met_e3_lite::operator met_e3_lite::row_dofs_type & ( )

Conversion (cast) operator to convert to the associated row dofs type (non const version).

Definition at line 225 of file met_e3.cc.

◆ operator=() [1/3]

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

Assignment operator.

Postcondition

invariant()

for(int i = ( 0 ); i < ( d() ); ++ i ) component(i) == xother[i]

Definition at line 84 of file met_e3.cc.

References _row_dofs, and ~met_e3_lite().

Referenced by met_e3_lite().

◆ operator=() [2/3]

fiber_bundle::met_e3_lite & fiber_bundle::met_e3_lite::operator= ( const row_dofs_type & xrow_dofs )

Assignment (from a row dofs type) operator.

Postcondition

invariant()

Definition at line 137 of file met_e3.cc.

References met_e3_lite().

◆ operator=() [3/3]

fiber_bundle::met_e3_lite & fiber_bundle::met_e3_lite::operator= ( const matrix_type & xmatrix )

Assignment (from a matrix type) operator.

Postcondition

invariant()

Definition at line 173 of file met_e3.cc.

◆ put_components()

void fiber_bundle::met_e3_lite::put_components	(	const value_type &	xx_comp,
		const value_type &	xy_comp,
		const value_type &	xz_comp,
		const value_type &	yy_comp,
		const value_type &	yz_comp,
		const value_type &	zz_comp
	)

virtual

Postcondition

invariant()

isunordered_or_equals(component(0), xx_comp)

isunordered_or_equals(component(1), xy_comp)

isunordered_or_equals(component(2), xz_comp)

isunordered_or_equals(component(3), yy_comp)

isunordered_or_equals(component(4), yz_comp)

isunordered_or_equals(component(5), zz_comp)

Definition at line 285 of file met_e3.cc.

References dd(), and sheaf::isunordered_or_equals().

Referenced by met_e3_lite().

◆ row_dofs() [1/2]

void * fiber_bundle::met_e3_lite::row_dofs ( )

virtual

The row dofs for this instance (mutable version).

Reimplemented from fiber_bundle::any_lite.

Definition at line 608 of file met_e3.cc.

Referenced by invariant().

◆ row_dofs() [2/2]

const void * fiber_bundle::met_e3_lite::row_dofs ( ) const

virtual

The row dofs for this instance (const version).

Reimplemented from fiber_bundle::any_lite.

Definition at line 615 of file met_e3.cc.

References fiber_bundle::met_e3::standard_schema_path().

◆ static_class_name()

const std::string & fiber_bundle::met_e3_lite::static_class_name ( )

static

The name of this class.

Postcondition

!result.empty()

Definition at line 509 of file met_e3.cc.

References clone().

Referenced by class_name().

◆ stp_prototype()

const fiber_bundle::stp_lite & fiber_bundle::met_e3_lite::stp_prototype ( int xp ) const

virtual

Prototype for symmetric tensors of degree xp over this vector space.

Precondition

precondition_of(e3_lite::static_stp_prototype(xp))

Postcondition

postcondition_of(e3_lite::static_stp_prototype(xp))

Reimplemented from fiber_bundle::vd_lite.

Definition at line 447 of file met_e3.cc.

References class_name().

Referenced by atp_prototype().

◆ tp_prototype()

const fiber_bundle::tp_lite & fiber_bundle::met_e3_lite::tp_prototype ( int xp ) const

virtual

Prototype for general tensors of degree xp over this vector space.

Precondition

precondition_of(e3_lite::static_tp_prototype(xp))

Postcondition

postcondition_of(e3_lite::static_tp_prototype(xp))

Reimplemented from fiber_bundle::vd_lite.

Definition at line 405 of file met_e3.cc.

References atp_prototype().

Referenced by dd().

Member Data Documentation

◆ _row_dofs

row_dofs_type fiber_bundle::met_e3_lite::_row_dofs

protected

Row_dofs_type.

Definition at line 263 of file met_e3.h.

Referenced by operator=().

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

EUCLIDEAN METRIC 3D (MET_E3) FACET OF CLASS MET_E3_LITE

TENSOR ALGEBRA (TP) FACET OF CLASS MET_E3_LITE

VECTOR ALGEBRA (VD) FACET OF CLASS MET_E3_LITE

ABSTRACT POSET MEMBER FACET OF CLASS MET_E3_LITE

ANY FACET OF CLASS MET_E3_LITE

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ matrix_type

◆ row_dofs_type

◆ vector_space_type

Constructor & Destructor Documentation

◆ met_e3_lite() [1/5]

◆ met_e3_lite() [2/5]

◆ ~met_e3_lite()

◆ met_e3_lite() [3/5]

◆ met_e3_lite() [4/5]

◆ met_e3_lite() [5/5]

Member Function Documentation

◆ atp_prototype()

◆ class_name()

◆ clone() [1/2]

◆ clone() [2/2]

◆ dd()

◆ invariant()

◆ is_ancestor_of()

◆ operator const matrix_type &()

◆ operator const row_dofs_type &()

◆ operator matrix_type &()

◆ operator row_dofs_type &()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ put_components()

◆ row_dofs() [1/2]

◆ row_dofs() [2/2]

◆ static_class_name()

◆ stp_prototype()

◆ tp_prototype()

Member Data Documentation

◆ _row_dofs