oomph::RankFiveTensor< T > Class Template Reference

A Rank 5 Tensor class. More...

#include <matrices.h>

Public Member Functions
	RankFiveTensor ()
	Empty constructor.
	RankFiveTensor (const RankFiveTensor &source_tensor)
	Copy constructor: Deep copy.
RankFiveTensor &	operator= (const RankFiveTensor &source_tensor)
	Copy assignement.
	RankFiveTensor (const unsigned long &n)
	One parameter constructor produces a nxnxnxnxn tensor.
	RankFiveTensor (const unsigned long &n_index1, const unsigned long &n_index2, const unsigned long &n_index3, const unsigned long &n_index4, const unsigned long &n_index5)
	Four parameter constructor, general non-square tensor.
	RankFiveTensor (const unsigned long &n_index1, const unsigned long &n_index2, const unsigned long &n_index3, const unsigned long &n_index4, const unsigned long &n_index5, const T &initial_val)
	Four parameter constructor, general non-square tensor.
virtual	~RankFiveTensor ()
	Destructor: delete the pointers.
void	resize (const unsigned long &n)
	Resize to a square nxnxnxn tensor.
void	resize (const unsigned long &n_index1, const unsigned long &n_index2, const unsigned long &n_index3, const unsigned long &n_index4, const unsigned long &n_index5)
	Resize to a general tensor.
void	resize (const unsigned long &n_index1, const unsigned long &n_index2, const unsigned long &n_index3, const unsigned long &n_index4, const unsigned long &n_index5, const T &initial_value)
	Resize to a general tensor.
void	initialise (const T &val)
	Initialise all values in the tensor to val.
unsigned long	nindex1 () const
	Return the range of index 1 of the tensor.
unsigned long	nindex2 () const
	Return the range of index 2 of the tensor.
unsigned long	nindex3 () const
	Return the range of index 3 of the tensor.
unsigned long	nindex4 () const
	Return the range of index 4 of the tensor.
unsigned long	nindex5 () const
	Return the range of index 5 of the tensor.
T &	operator() (const unsigned long &i, const unsigned long &j, const unsigned long &k, const unsigned long &l, const unsigned long &m)
	Overload the round brackets to give access as a(i,j,k,l,m)
T	operator() (const unsigned long &i, const unsigned long &j, const unsigned long &k, const unsigned long &l, const unsigned long &m) const
	Overload a const version for read-only access as a(i,j,k,l,m)
T &	raw_direct_access (const unsigned long &i)
	Direct access to internal storage of data in flat-packed C-style column-major format. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.
const T &	raw_direct_access (const unsigned long &i) const
	Direct access to internal storage of data in flat-packed C-style column-major format. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.
unsigned	offset (const unsigned long &i, const unsigned long &j, const unsigned long &k) const
	Caculate the offset in flat-packed Cy-style, column-major format, required for a given i,j,k. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.

Private Member Functions
void	range_check (const unsigned long &i, const unsigned long &j, const unsigned long &k, const unsigned long &l, const unsigned long &m) const
	Range check to catch when an index is out of bounds, if so, it issues a warning message and dies by throwing an OomphLibError.

Private Attributes
T *	Tensordata
	Private internal representation as pointer to data.
unsigned	N
	1st Tensor dimension
unsigned	M
	2nd Tensor dimension
unsigned	P
	3rd Tensor dimension
unsigned	Q
	4th Tensor dimension
unsigned	R
	5th Tensor dimension

Detailed Description

template<class T>
class oomph::RankFiveTensor< T >

A Rank 5 Tensor class.

Definition at line 2199 of file matrices.h.

Constructor & Destructor Documentation

RankFiveTensor() [1/5]

template<class T >

oomph::RankFiveTensor< T >::RankFiveTensor ( )

inline

Empty constructor.

Definition at line 2282 of file matrices.h.

RankFiveTensor() [2/5]

template<class T >

oomph::RankFiveTensor< T >::RankFiveTensor ( const RankFiveTensor< T > &  source_tensor )

inline

Copy constructor: Deep copy.

Definition at line 2285 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

RankFiveTensor() [3/5]

template<class T >

oomph::RankFiveTensor< T >::RankFiveTensor ( const unsigned long &  n )

inline

One parameter constructor produces a nxnxnxnxn tensor.

Definition at line 2359 of file matrices.h.

References oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

RankFiveTensor() [4/5]

template<class T >

oomph::RankFiveTensor< T >::RankFiveTensor ( const unsigned long &  n_index1, const unsigned long &  n_index2, const unsigned long &  n_index3, const unsigned long &  n_index4, const unsigned long &  n_index5  )

inline

Four parameter constructor, general non-square tensor.

Definition at line 2376 of file matrices.h.

References oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

RankFiveTensor() [5/5]

template<class T >

oomph::RankFiveTensor< T >::RankFiveTensor ( const unsigned long &  n_index1, const unsigned long &  n_index2, const unsigned long &  n_index3, const unsigned long &  n_index4, const unsigned long &  n_index5, const T &  initial_val  )

inline

Four parameter constructor, general non-square tensor.

Definition at line 2398 of file matrices.h.

References oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

~RankFiveTensor()

template<class T >

virtual oomph::RankFiveTensor< T >::~RankFiveTensor ( )

inlinevirtual

Destructor: delete the pointers.

Definition at line 2418 of file matrices.h.

References oomph::RankFiveTensor< T >::Tensordata.

Member Function Documentation

initialise()

template<class T >

void oomph::RankFiveTensor< T >::initialise ( const T &  val )

inline

Initialise all values in the tensor to val.

Definition at line 2564 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

Referenced by oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

nindex1()

template<class T >

unsigned long oomph::RankFiveTensor< T >::nindex1 ( ) const

inline

Return the range of index 1 of the tensor.

Definition at line 2573 of file matrices.h.

References oomph::RankFiveTensor< T >::N.

nindex2()

template<class T >

unsigned long oomph::RankFiveTensor< T >::nindex2 ( ) const

inline

Return the range of index 2 of the tensor.

Definition at line 2579 of file matrices.h.

References oomph::RankFiveTensor< T >::M.

nindex3()

template<class T >

unsigned long oomph::RankFiveTensor< T >::nindex3 ( ) const

inline

Return the range of index 3 of the tensor.

Definition at line 2585 of file matrices.h.

References oomph::RankFiveTensor< T >::P.

nindex4()

template<class T >

unsigned long oomph::RankFiveTensor< T >::nindex4 ( ) const

inline

Return the range of index 4 of the tensor.

Definition at line 2591 of file matrices.h.

References oomph::RankFiveTensor< T >::Q.

nindex5()

template<class T >

unsigned long oomph::RankFiveTensor< T >::nindex5 ( ) const

inline

Return the range of index 5 of the tensor.

Definition at line 2597 of file matrices.h.

References oomph::RankFiveTensor< T >::R.

offset()

template<class T >

unsigned oomph::RankFiveTensor< T >::offset ( const unsigned long &  i, const unsigned long &  j, const unsigned long &  k  ) const

inline

Caculate the offset in flat-packed Cy-style, column-major format, required for a given i,j,k. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.

Definition at line 2651 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, and oomph::RankFiveTensor< T >::R.

operator()() [1/2]

template<class T >

T & oomph::RankFiveTensor< T >::operator() ( const unsigned long &  i, const unsigned long &  j, const unsigned long &  k, const unsigned long &  l, const unsigned long &  m  )

inline

Overload the round brackets to give access as a(i,j,k,l,m)

Definition at line 2603 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, oomph::RankFiveTensor< T >::range_check(), and oomph::RankFiveTensor< T >::Tensordata.

operator()() [2/2]

template<class T >

T oomph::RankFiveTensor< T >::operator() ( const unsigned long &  i, const unsigned long &  j, const unsigned long &  k, const unsigned long &  l, const unsigned long &  m  ) const

inline

Overload a const version for read-only access as a(i,j,k,l,m)

Definition at line 2616 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, oomph::RankFiveTensor< T >::range_check(), and oomph::RankFiveTensor< T >::Tensordata.

operator=()

template<class T >

RankFiveTensor & oomph::RankFiveTensor< T >::operator= ( const RankFiveTensor< T > &  source_tensor )

inline

Copy assignement.

Definition at line 2318 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::resize().

range_check()

template<class T >

void oomph::RankFiveTensor< T >::range_check ( const unsigned long &  i, const unsigned long &  j, const unsigned long &  k, const unsigned long &  l, const unsigned long &  m  ) const

inlineprivate

Range check to catch when an index is out of bounds, if so, it issues a warning message and dies by throwing an OomphLibError.

Definition at line 2222 of file matrices.h.

References i, oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, and oomph::RankFiveTensor< T >::R.

Referenced by oomph::RankFiveTensor< T >::operator()(), and oomph::RankFiveTensor< T >::operator()().

raw_direct_access() [1/2]

template<class T >

T & oomph::RankFiveTensor< T >::raw_direct_access ( const unsigned long &  i )

inline

Direct access to internal storage of data in flat-packed C-style column-major format. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.

Definition at line 2632 of file matrices.h.

References i, and oomph::RankFiveTensor< T >::Tensordata.

raw_direct_access() [2/2]

template<class T >

const T & oomph::RankFiveTensor< T >::raw_direct_access ( const unsigned long &  i ) const

inline

Direct access to internal storage of data in flat-packed C-style column-major format. WARNING: Only for experienced users. Only use this if raw speed is of the essence, as in the solid mechanics problems.

Definition at line 2642 of file matrices.h.

References i, and oomph::RankFiveTensor< T >::Tensordata.

resize() [1/3]

template<class T >

void oomph::RankFiveTensor< T >::resize ( const unsigned long &  n )

inline

Resize to a square nxnxnxn tensor.

Definition at line 2425 of file matrices.h.

References oomph::RankFiveTensor< T >::resize().

Referenced by oomph::RankFiveTensor< T >::operator=(), and oomph::RankFiveTensor< T >::resize().

resize() [2/3]

template<class T >

void oomph::RankFiveTensor< T >::resize ( const unsigned long &  n_index1, const unsigned long &  n_index2, const unsigned long &  n_index3, const unsigned long &  n_index4, const unsigned long &  n_index5  )

inline

Resize to a general tensor.

Definition at line 2431 of file matrices.h.

References i, oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

resize() [3/3]

template<class T >

void oomph::RankFiveTensor< T >::resize ( const unsigned long &  n_index1, const unsigned long &  n_index2, const unsigned long &  n_index3, const unsigned long &  n_index4, const unsigned long &  n_index5, const T &  initial_value  )

inline

Resize to a general tensor.

Definition at line 2497 of file matrices.h.

References i, oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::M, oomph::RankFiveTensor< T >::N, oomph::RankFiveTensor< T >::P, oomph::RankFiveTensor< T >::Q, oomph::RankFiveTensor< T >::R, and oomph::RankFiveTensor< T >::Tensordata.

Member Data Documentation

M

template<class T >

unsigned oomph::RankFiveTensor< T >::M

private

2nd Tensor dimension

Definition at line 2209 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::nindex2(), oomph::RankFiveTensor< T >::offset(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator=(), oomph::RankFiveTensor< T >::range_check(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

N

template<class T >

unsigned oomph::RankFiveTensor< T >::N

private

1st Tensor dimension

Definition at line 2206 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::nindex1(), oomph::RankFiveTensor< T >::operator=(), oomph::RankFiveTensor< T >::range_check(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

P

template<class T >

unsigned oomph::RankFiveTensor< T >::P

private

3rd Tensor dimension

Definition at line 2212 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::nindex3(), oomph::RankFiveTensor< T >::offset(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator=(), oomph::RankFiveTensor< T >::range_check(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

Q

template<class T >

unsigned oomph::RankFiveTensor< T >::Q

private

4th Tensor dimension

Definition at line 2215 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::nindex4(), oomph::RankFiveTensor< T >::offset(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator=(), oomph::RankFiveTensor< T >::range_check(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

R

template<class T >

unsigned oomph::RankFiveTensor< T >::R

private

5th Tensor dimension

Definition at line 2218 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::nindex5(), oomph::RankFiveTensor< T >::offset(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator=(), oomph::RankFiveTensor< T >::range_check(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::resize().

Tensordata

template<class T >

T* oomph::RankFiveTensor< T >::Tensordata

private

Private internal representation as pointer to data.

Definition at line 2203 of file matrices.h.

Referenced by oomph::RankFiveTensor< T >::initialise(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::operator()(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::RankFiveTensor(), oomph::RankFiveTensor< T >::raw_direct_access(), oomph::RankFiveTensor< T >::raw_direct_access(), oomph::RankFiveTensor< T >::resize(), oomph::RankFiveTensor< T >::resize(), and oomph::RankFiveTensor< T >::~RankFiveTensor().

---

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

• matrices.h