SPH
Public Member Functions | Static Public Member Functions | Friends | List of all members
AntisymmetricTensor Class Reference

#include <AntisymmetricTensor.h>

Public Member Functions

 AntisymmetricTensor ()=default
 
 AntisymmetricTensor (const Vector &v)
 
 AntisymmetricTensor (const PseudoVectorTag, const Vector &v)
 
 AntisymmetricTensor (const Float v)
 Constructs an antisymmetric tensor by setting all components above the diagonal to the same value. More...
 
INLINE Vector & components ()
 Returns the components above diagonal as vector. More...
 
INLINE const Vector & components () const
 Returns the components above diagonal as vector. More...
 
Vector pseudovector () const
 Returns the associated pseudovector. More...
 
INLINE Vector operator[] (const Size idx) const
 Returns a row of the matrix. More...
 
INLINE Float operator() (const Size i, const Size j) const
 Returns element on given with given indices. More...
 
INLINE AntisymmetricTensor operator+= (const AntisymmetricTensor &other)
 
INLINE AntisymmetricTensor operator-= (const AntisymmetricTensor &other)
 
INLINE AntisymmetricTensor operator- () const
 

Static Public Member Functions

static INLINE AntisymmetricTensor null ()
 

Friends

bool operator== (const AntisymmetricTensor &t1, const AntisymmetricTensor &t2)
 
AntisymmetricTensor operator+ (const AntisymmetricTensor &t1, const AntisymmetricTensor &t2)
 
AntisymmetricTensor operator- (const AntisymmetricTensor &t1, const AntisymmetricTensor &t2)
 
AntisymmetricTensor operator* (const AntisymmetricTensor &t, const Float v)
 
AntisymmetricTensor operator* (const Float v, const AntisymmetricTensor &t)
 
AntisymmetricTensor operator/ (const AntisymmetricTensor &t, const Float v)
 
std::ostream & operator<< (std::ostream &stream, const AntisymmetricTensor &t)
 

Detailed Description

Definition at line 18 of file AntisymmetricTensor.h.

Constructor & Destructor Documentation

◆ AntisymmetricTensor() [1/4]

AntisymmetricTensor::AntisymmetricTensor ( )
default

◆ AntisymmetricTensor() [2/4]

AntisymmetricTensor::AntisymmetricTensor ( const Vector &  v)
inlineexplicit

Constructs an antisymmetric tensor given three independed components. Components x, y, z in vector correspond to components xy, xz, yz of the antisymmetric tensor.

Definition at line 27 of file AntisymmetricTensor.h.

◆ AntisymmetricTensor() [3/4]

AntisymmetricTensor::AntisymmetricTensor ( const  PseudoVectorTag,
const Vector &  v 
)
inlineexplicit

Constructs an antisymmetric tensor from a corresponding pseudovector. Here we use right-hand convention, same as for cross product.

Definition at line 32 of file AntisymmetricTensor.h.

◆ AntisymmetricTensor() [4/4]

AntisymmetricTensor::AntisymmetricTensor ( const Float  v)
inlineexplicit

Constructs an antisymmetric tensor by setting all components above the diagonal to the same value.

Definition at line 36 of file AntisymmetricTensor.h.

Member Function Documentation

◆ components() [1/2]

INLINE Vector& AntisymmetricTensor::components ( )
inline

Returns the components above diagonal as vector.

Definition at line 40 of file AntisymmetricTensor.h.

◆ components() [2/2]

INLINE const Vector& AntisymmetricTensor::components ( ) const
inline

Returns the components above diagonal as vector.

Definition at line 45 of file AntisymmetricTensor.h.

◆ null()

static INLINE AntisymmetricTensor AntisymmetricTensor::null ( )
inlinestatic

Definition at line 79 of file AntisymmetricTensor.h.

◆ operator()()

INLINE Float AntisymmetricTensor::operator() ( const Size  i,
const Size  j 
) const
inline

Returns element on given with given indices.

Definition at line 69 of file AntisymmetricTensor.h.

◆ operator+=()

INLINE AntisymmetricTensor AntisymmetricTensor::operator+= ( const AntisymmetricTensor &  other)
inline

Definition at line 83 of file AntisymmetricTensor.h.

◆ operator-()

INLINE AntisymmetricTensor AntisymmetricTensor::operator- ( ) const
inline

Definition at line 93 of file AntisymmetricTensor.h.

◆ operator-=()

INLINE AntisymmetricTensor AntisymmetricTensor::operator-= ( const AntisymmetricTensor &  other)
inline

Definition at line 88 of file AntisymmetricTensor.h.

◆ operator[]()

INLINE Vector AntisymmetricTensor::operator[] ( const Size  idx) const
inline

Returns a row of the matrix.

Definition at line 55 of file AntisymmetricTensor.h.

◆ pseudovector()

Vector AntisymmetricTensor::pseudovector ( ) const
inline

Returns the associated pseudovector.

Definition at line 50 of file AntisymmetricTensor.h.

Friends And Related Function Documentation

◆ operator* [1/2]

AntisymmetricTensor operator* ( const AntisymmetricTensor &  t,
const Float  v 
)
friend

Definition at line 109 of file AntisymmetricTensor.h.

◆ operator* [2/2]

AntisymmetricTensor operator* ( const Float  v,
const AntisymmetricTensor &  t 
)
friend

Definition at line 113 of file AntisymmetricTensor.h.

◆ operator+

AntisymmetricTensor operator+ ( const AntisymmetricTensor &  t1,
const AntisymmetricTensor &  t2 
)
friend

Definition at line 101 of file AntisymmetricTensor.h.

◆ operator-

AntisymmetricTensor operator- ( const AntisymmetricTensor &  t1,
const AntisymmetricTensor &  t2 
)
friend

Definition at line 105 of file AntisymmetricTensor.h.

◆ operator/

AntisymmetricTensor operator/ ( const AntisymmetricTensor &  t,
const Float  v 
)
friend

Definition at line 117 of file AntisymmetricTensor.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const AntisymmetricTensor &  t 
)
friend

Definition at line 121 of file AntisymmetricTensor.h.

◆ operator==

bool operator== ( const AntisymmetricTensor &  t1,
const AntisymmetricTensor &  t2 
)
friend

Definition at line 97 of file AntisymmetricTensor.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1