Public Types | Public Member Functions
C3DCriticalPointEigen Class Reference

A class to hold a criticalpoint with eigenvalues and eigenvectors. More...

#include <mia/3d/critical_point.hh>

Public Types

enum  EVType {
  ev_zero, ev_real, ev_real_two_equal, ev_real_three_equal,
  ev_complex
}
 types of critical points More...
 

Public Member Functions

 C3DCriticalPointEigen (C3DCriticalPoint cp)
 
 C3DCriticalPointEigen (const C3DFVector &l, const C3DFMatrix &m)
 
 C3DCriticalPointEigen (const C3DFVector &location_, const C3DFMatrix &portrait_, float eval1, float eval2, float eval3, const C3DFVector &evec1, const C3DFVector &evec2, const C3DFVector &evec3, EVType type)
 
fcomplex get_complex_eval2 () const
 
fcomplex get_complex_eval3 () const
 
const C3DCVector get_complex_evect2 () const
 
const C3DCVector get_complex_evect3 () const
 
float get_eval1 () const
 
float get_eval2 () const
 
float get_eval3 () const
 
const C3DFVector get_evect1 () const
 
const C3DFVector get_evect2 () const
 
const C3DFVector get_evect3 () const
 
const C3DFVector get_location () const
 
const C3DFMatrix get_portrait () const
 
float get_real_eval2 () const
 
float get_real_eval3 () const
 
const C3DFVector get_real_evect2 () const
 
const C3DFVector get_real_evect3 () const
 
EVType get_type () const
 

Detailed Description

A class to hold a criticalpoint with eigenvalues and eigenvectors.

Remarks
untested

Definition at line 145 of file critical_point.hh.

Member Enumeration Documentation

types of critical points

Enumerator
ev_zero 

all eigenvalues are zero (more a placeholder)

ev_real 

three real distinct eigenvalues

ev_real_two_equal 

three real eigenvalues, two equal

ev_real_three_equal 

three real eigenvalues, all equal

ev_complex 

Definition at line 171 of file critical_point.hh.

Constructor & Destructor Documentation

C3DCriticalPointEigen::C3DCriticalPointEigen ( C3DCriticalPoint  cp)

Construtor to create a critical point with evaluated eigenvalues and - vectors from a critical point.

Parameters
cpthe critical point to construct from
C3DCriticalPointEigen::C3DCriticalPointEigen ( const C3DFVector l,
const C3DFMatrix m 
)

Construtor to create a critical point with evaluated eigenvalues and - vectors .

Parameters
llocation of the critical point
mphase portrait of the critical point
C3DCriticalPointEigen::C3DCriticalPointEigen ( const C3DFVector location_,
const C3DFMatrix portrait_,
float  eval1,
float  eval2,
float  eval3,
const C3DFVector evec1,
const C3DFVector evec2,
const C3DFVector evec3,
EVType  type 
)

Contruct a critical point from given data.

Parameters
location_location of critical point
portrait_phase portrait of critical point
eval1first eigenvalue (always real)
eval2second real eigenvalue or real part of conjugated complex ones
eval3third real eigenvalue or imaginary part of conjugated complex ones
evec1first eigenvector (always real)
evec2second real eigenvector or real part of conjugated complex ones
evec3third real eigenvector or imaginary part of conjugated complex ones
typehow to interpret the second and third eigenvalues/-vectors

Member Function Documentation

fcomplex C3DCriticalPointEigen::get_complex_eval2 ( ) const
inline
Return values
getsecond eigenvalue as complex
Remarks
asserts whether eigenvalue is really complex

Definition at line 301 of file critical_point.hh.

References ev_complex.

fcomplex C3DCriticalPointEigen::get_complex_eval3 ( ) const
inline
Return values
getthird eigenvalue as complex
Remarks
asserts whether eigenvalue is really complex

Definition at line 306 of file critical_point.hh.

References ev_complex.

const C3DCVector C3DCriticalPointEigen::get_complex_evect2 ( ) const
inline

Definition at line 334 of file critical_point.hh.

References ev_complex, T3DVector< T >::x, T3DVector< T >::y, and T3DVector< T >::z.

const C3DCVector C3DCriticalPointEigen::get_complex_evect3 ( ) const
inline

Definition at line 341 of file critical_point.hh.

References ev_complex, T3DVector< T >::x, T3DVector< T >::y, and T3DVector< T >::z.

float C3DCriticalPointEigen::get_eval1 ( ) const
inline
Return values
getfirst eigenvalue

Definition at line 278 of file critical_point.hh.

float C3DCriticalPointEigen::get_eval2 ( ) const
inline
Return values
getsecond eigenvalue as real
Remarks
use only for loading and storing

Definition at line 282 of file critical_point.hh.

float C3DCriticalPointEigen::get_eval3 ( ) const
inline
Return values
getsecond eigenvalue as real
Remarks
use only for loading and storing

Definition at line 286 of file critical_point.hh.

const C3DFVector C3DCriticalPointEigen::get_evect1 ( ) const
inline
Return values
acopy of the first eigenvector

Definition at line 312 of file critical_point.hh.

const C3DFVector C3DCriticalPointEigen::get_evect2 ( ) const
inline
Return values
acopy of the second eigenvector as real
Remarks
use only for loading and storing

Definition at line 316 of file critical_point.hh.

const C3DFVector C3DCriticalPointEigen::get_evect3 ( ) const
inline
Return values
acopy of the third eigenvector as real
Remarks
use only for loading and storing

Definition at line 320 of file critical_point.hh.

const C3DFVector C3DCriticalPointEigen::get_location ( ) const
inline
Return values
acopy of the location

Definition at line 349 of file critical_point.hh.

const C3DFMatrix C3DCriticalPointEigen::get_portrait ( ) const
inline
Return values
acopy of the phase portrait

Definition at line 355 of file critical_point.hh.

float C3DCriticalPointEigen::get_real_eval2 ( ) const
inline
Return values
getsecond eigenvalue as real
Remarks
asserts whether eigenvalue is really real

Definition at line 291 of file critical_point.hh.

References ev_complex.

float C3DCriticalPointEigen::get_real_eval3 ( ) const
inline
Return values
getthird eigenvalue as real
Remarks
asserts whether eigenvalue is really real

Definition at line 296 of file critical_point.hh.

References ev_complex.

const C3DFVector C3DCriticalPointEigen::get_real_evect2 ( ) const
inline

Definition at line 324 of file critical_point.hh.

References ev_complex.

const C3DFVector C3DCriticalPointEigen::get_real_evect3 ( ) const
inline

Definition at line 329 of file critical_point.hh.

References ev_complex.

C3DCriticalPointEigen::EVType C3DCriticalPointEigen::get_type ( ) const
inline
Return values
typeof eigenvalues and eigenvectors

Definition at line 274 of file critical_point.hh.


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