Abstract jacobian class (volatile version). More...

#include <jcb.h>

Inheritance diagram for fiber_bundle::jcb_lite:

JACOBIAN (JCB) FACET OF CLASS JCB_LITE
typedef jcb_table_dofs_type	table_dofs_type
	The type of the table dofs. More...

	jcb_lite ()
	Default constructor. More...

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

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

virtual	~jcb_lite ()
	Destructor. More...

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

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

virtual int	dd () const
	Dimension of the domain. More...

virtual int	dr () const
	Dimension of the range. More...

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

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

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...

VECTOR ALGEBRA (VD) FACET OF CLASS JCB_LITE
virtual int	d () const
	Dimension of this as a vector space. More...

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

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

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

ANY FACET OF CLASS JCB_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...

Additional Inherited Members
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::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 const tp_lite &	tp_prototype (int xp) const
	Virtual constructor 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...

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...

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...

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

Abstract jacobian class (volatile version).

Definition at line 54 of file jcb.h.

Member Typedef Documentation

◆ table_dofs_type

typedef jcb_table_dofs_type fiber_bundle::jcb_lite::table_dofs_type

The type of the table dofs.

Definition at line 66 of file jcb.h.

Constructor & Destructor Documentation

◆ jcb_lite() [1/3]

fiber_bundle::jcb_lite::jcb_lite ( )

Default constructor.

Postcondition

invariant()

Definition at line 46 of file jcb.cc.

Referenced by ~jcb_lite().

◆ jcb_lite() [2/3]

fiber_bundle::jcb_lite::jcb_lite ( const jcb_lite & xother )

Copy constructor.

Postcondition

invariant()

Definition at line 60 of file jcb.cc.

References operator=().

◆ ~jcb_lite()

fiber_bundle::jcb_lite::~jcb_lite ( )

virtual

Destructor.

Definition at line 93 of file jcb.cc.

References jcb_lite().

Referenced by operator=().

◆ jcb_lite() [3/3]

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

Creates a new instance with row dofs xrow_dofs.

Postcondition

invariant()

Definition at line 108 of file jcb.cc.

References operator=().

Member Function Documentation

◆ class_name()

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

virtual

The name of this class.

Postcondition

!result.empty()

Reimplemented from fiber_bundle::vd_lite.

Reimplemented in fiber_bundle::jcb_e33_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::jcb_e23_lite, and fiber_bundle::jcb_ed_lite.

Definition at line 353 of file jcb.cc.

References static_class_name().

Referenced by d().

◆ clone()

fiber_bundle::jcb_lite * fiber_bundle::jcb_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::vd_lite.

Reimplemented in fiber_bundle::jcb_e33_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::jcb_e23_lite, and fiber_bundle::jcb_ed_lite.

Definition at line 391 of file jcb.cc.

Referenced by static_class_name().

◆ component()

fiber_bundle::jcb_lite::value_type fiber_bundle::jcb_lite::component	(	int	xrow,
		int	xcolumn
	)		const

The value of the component in a specified row and column (const version).

Precondition

xrow >= 0 && xrow < dr()

xcolumn >= 0 && xcolumn < dd()

Postcondition

invariant()

Definition at line 229 of file jcb.cc.

References put_component().

Referenced by fiber_bundle::jcb_algebra::pull(), fiber_bundle::jcb_algebra::push(), and table_dofs().

◆ d()

int fiber_bundle::jcb_lite::d ( ) const

virtual

Dimension of this as a vector space.

Postcondition

invariant()

result==dd()*dr()

Reimplemented from fiber_bundle::vd_lite.

Definition at line 311 of file jcb.cc.

References class_name().

Referenced by index_for_row_column().

◆ dd()

int fiber_bundle::jcb_lite::dd ( ) const

virtual

Dimension of the domain.

Postcondition

invariant()

result == 0

Reimplemented in fiber_bundle::jcb_e33_lite, fiber_bundle::jcb_e13_lite, and fiber_bundle::jcb_e23_lite.

Definition at line 145 of file jcb.cc.

References dr().

Referenced by operator=(), fiber_bundle::jcb_algebra::pull(), and fiber_bundle::jcb_algebra::push().

◆ dr()

int fiber_bundle::jcb_lite::dr ( ) const

virtual

Dimension of the range.

Postcondition

invariant()

result == 0

Reimplemented in fiber_bundle::jcb_e33_lite, fiber_bundle::jcb_e13_lite, and fiber_bundle::jcb_e23_lite.

Definition at line 165 of file jcb.cc.

References table_dofs().

Referenced by dd(), fiber_bundle::jcb_algebra::pull(), and fiber_bundle::jcb_algebra::push().

◆ index_for_row_column()

int fiber_bundle::jcb_lite::index_for_row_column	(	int	xrow,
		int	xcolumn
	)		const

virtual

The index into linear storage of the component in a specified row and column.

Precondition

0 <= xrow && xrow < dr()

0 <= xcolumn && xcolumn < dd()

Postcondition

invariant()

result >= 0

result < dr()*dd()

Definition at line 274 of file jcb.cc.

References d().

Referenced by put_component().

◆ invariant()

bool fiber_bundle::jcb_lite::invariant ( ) const

Class invariant.

Invariant

vd_lite::invariant()

Definition at line 443 of file jcb.cc.

References fiber_bundle::jcb::standard_schema_path().

Referenced by is_ancestor_of().

◆ is_ancestor_of()

bool fiber_bundle::jcb_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::vd_lite.

Reimplemented in fiber_bundle::jcb_e33_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::jcb_e23_lite, and fiber_bundle::jcb_ed_lite.

Definition at line 424 of file jcb.cc.

References invariant().

◆ operator=() [1/2]

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

Assignment operator.

Postcondition

invariant()

Definition at line 75 of file jcb.cc.

References ~jcb_lite().

Referenced by jcb_lite().

◆ operator=() [2/2]

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

Assignment (from row_dofs_type) operator.

Definition at line 125 of file jcb.cc.

References dd().

◆ put_component()

void fiber_bundle::jcb_lite::put_component	(	int	xrow,
		int	xcolumn,
		value_type	xcomp
	)

Sets value of a component in a specified row and column.

Precondition

xrow >= 0 && xrow < dr()

xcolumn >= 0 && xcolumn < dd()

Postcondition

invariant()

isunordered_or_equals(component(index_for_row_column(xrow, xcolumn)), xcomp)

Definition at line 251 of file jcb.cc.

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

Referenced by component().

◆ static_class_name()

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

static

The name of this class.

Postcondition

!result.empty()

Definition at line 372 of file jcb.cc.

References clone().

Referenced by class_name().

◆ table_dofs()

fiber_bundle::jcb_lite::table_dofs_type fiber_bundle::jcb_lite::table_dofs ( ) const

The table dofs.

Issue:: : where do these strings get deleted?

Definition at line 186 of file jcb.cc.

References component(), fiber_bundle::jcb_table_dofs_type::d, fiber_bundle::jcb_table_dofs_type::dd, fiber_bundle::jcb_table_dofs_type::domain_path, fiber_bundle::jcb_table_dofs_type::dr, fiber_bundle::jcb_table_dofs_type::factor_ct, fiber_bundle::jcb_table_dofs_type::range_path, and fiber_bundle::jcb_table_dofs_type::scalar_space_path.

Referenced by dr().

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

jcb.h
jcb.cc

JACOBIAN (JCB) FACET OF CLASS JCB_LITE

VECTOR ALGEBRA (VD) FACET OF CLASS JCB_LITE

ABSTRACT POSET MEMBER FACET OF CLASS JCB_LITE

ANY FACET OF CLASS JCB_LITE

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ table_dofs_type

Constructor & Destructor Documentation

◆ jcb_lite() [1/3]

◆ jcb_lite() [2/3]

◆ ~jcb_lite()

◆ jcb_lite() [3/3]

Member Function Documentation

◆ class_name()

◆ clone()

◆ component()

◆ d()

◆ dd()

◆ dr()

◆ index_for_row_column()

◆ invariant()

◆ is_ancestor_of()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ put_component()

◆ static_class_name()

◆ table_dofs()