Base_vect_cart Class Reference
[Tensorial fields]

Cartesian vectorial bases (triads). More...

#include <base_vect.h>

Inheritance diagram for Base_vect_cart:
Base_vect

List of all members.

Public Member Functions

 Base_vect_cart (double rot_phi_i)
 Standard constructor.
 Base_vect_cart (double rot_phi_i, const char *name_i)
 Standard constructor with name.
 Base_vect_cart (const Base_vect_cart &)
 Copy constructor.
virtual ~Base_vect_cart ()
 Destructor.
void operator= (const Base_vect_cart &)
 Assignment to another Base_vect_cart.
void set_rot_phi (double rot_phi_i)
 Sets a new value to the angle rot_phi between the x --axis and the absolute frame X --axis.
virtual bool operator== (const Base_vect &) const
 Comparison operator (egality).
virtual void change_basis (Tenseur &) const
 Change the basis in which the components of a tensor are expressed.
virtual int identify () const
 Returns a number to identify the sub-classe of Base_vect the object belongs to.
int get_align () const
 Returns the indicator of alignment with respect to the absolute frame.
virtual void sauve (FILE *) const
 Save in a file.
void set_name (const char *name_i)
 Sets the basis name.
const char * get_name () const
 Returns the basis name.
virtual bool operator== (const Base_vect &) const =0
 Comparison operator (egality).
bool operator!= (const Base_vect &) const
 Comparison operator (difference).

Static Public Member Functions

static Base_vect * bvect_from_file (FILE *)
 Construction of a vectorial basis from a file (see sauve(FILE* ) ).

Protected Member Functions

 Base_vect_cart (FILE *)
 Constructor from a file.
virtual ostream & operator>> (ostream &) const
 Operator >>.

Protected Attributes

char name [100]
 Name of the basis.

Private Member Functions

void set_align ()
 Computes align from the value of rot_phi.

Private Attributes

double rot_phi
 Angle between the x --axis and the absolute frame X --axis.
int align
 Indicator of alignment with respect to the absolute frame: \ align = 1 : basis aligned with the absolute frame (${\tt rot\_phi = 0}$) \ align = -1 : basis anti-aligned with the absolute frame (${\tt rot\_phi} = \pi$) \ align = 0 : general case.

Friends

Base_vect * Base_vect::bvect_from_file (FILE *)
 The construction function from a file.
ostream & operator<< (ostream &, const Base_vect &)
 Display.

Detailed Description

Cartesian vectorial bases (triads).

()

Definition at line 197 of file base_vect.h.

Constructor & Destructor Documentation

Base_vect_cart::Base_vect_cart ( double  rot_phi_i  )  [explicit]

Standard constructor.

Definition at line 106 of file base_vect_cart.C.

References set_align().

Base_vect_cart::Base_vect_cart ( double  rot_phi_i,
const char *  name_i 
)

Standard constructor with name.

Definition at line 116 of file base_vect_cart.C.

References set_align().

Base_vect_cart::Base_vect_cart ( const Base_vect_cart &  bi  ) 

Copy constructor.

Definition at line 126 of file base_vect_cart.C.

References set_align().

Base_vect_cart::Base_vect_cart ( FILE *  fich  )  [explicit, protected]

Constructor from a file.

This constructor is protected because any Base_vect_cart construction from a file must be done via the function Base_vect::bvect_from_file .

Definition at line 135 of file base_vect_cart.C.

References fread_be(), rot_phi, and set_align().

Base_vect_cart::~Base_vect_cart (  )  [virtual]

Destructor.

Definition at line 148 of file base_vect_cart.C.

Member Function Documentation

Base_vect * Base_vect::bvect_from_file ( FILE *  fich  )  [static, inherited]

Construction of a vectorial basis from a file (see sauve(FILE* ) ).

Definition at line 80 of file base_vect_from_file.C.

References fread_be().

void Base_vect_cart::change_basis ( Tenseur &  ti  )  const [virtual]

Change the basis in which the components of a tensor are expressed.

Implements Base_vect.

Definition at line 276 of file base_vect_cart.C.

References align, Tenseur::allocate_all(), Map::comp_x_from_spherical(), Map::comp_y_from_spherical(), Map::comp_z_from_spherical(), Map::get_bvect_cart(), Map::get_bvect_spher(), Tenseur::get_etat(), Tenseur::get_mp(), Tenseur::get_triad(), Tenseur::get_type_indice(), Tenseur::get_valence(), Tenseur::set(), and Tenseur::set_triad().

int Base_vect_cart::get_align (  )  const [inline]

Returns the indicator of alignment with respect to the absolute frame.

Returns:
1 : basis aligned with the absolute frame (${\tt rot\_phi = 0}$) \ -1 : basis anti-aligned with the absolute frame (${\tt rot\_phi} = \pi$) \ 0 : general case

Definition at line 281 of file base_vect.h.

References align.

const char * Base_vect::get_name (  )  const [inherited]

Returns the basis name.

Definition at line 136 of file base_vect.C.

References Base_vect::name.

int Base_vect_cart::identify (  )  const [virtual]

Returns a number to identify the sub-classe of Base_vect the object belongs to.

Implements Base_vect.

Definition at line 70 of file base_vect_from_file.C.

bool Base_vect::operator!= ( const Base_vect &  bi  )  const [inherited]

Comparison operator (difference).

Definition at line 170 of file base_vect.C.

void Base_vect_cart::operator= ( const Base_vect_cart &  bi  ) 

Assignment to another Base_vect_cart.

Reimplemented from Base_vect.

Definition at line 161 of file base_vect_cart.C.

References Base_vect::name, rot_phi, set_align(), and Base_vect::set_name().

virtual bool Base_vect::operator== ( const Base_vect &   )  const [pure virtual, inherited]

Comparison operator (egality).

bool Base_vect_cart::operator== ( const Base_vect &  bi  )  const [virtual]

Comparison operator (egality).

Definition at line 220 of file base_vect_cart.C.

References identify(), Base_vect::identify(), and rot_phi.

ostream & Base_vect_cart::operator>> ( ostream &  ost  )  const [protected, virtual]

Operator >>.

Implements Base_vect.

Definition at line 258 of file base_vect_cart.C.

References rot_phi.

void Base_vect_cart::sauve ( FILE *  fich  )  const [virtual]

Save in a file.

Reimplemented from Base_vect.

Definition at line 250 of file base_vect_cart.C.

References fwrite_be(), and rot_phi.

void Base_vect_cart::set_align (  )  [private]

Computes align from the value of rot_phi.

Definition at line 175 of file base_vect_cart.C.

References align, arrete(), and rot_phi.

void Base_vect::set_name ( const char *  name_i  )  [inherited]

Sets the basis name.

Definition at line 130 of file base_vect.C.

References Base_vect::name.

void Base_vect_cart::set_rot_phi ( double  rot_phi_i  ) 

Sets a new value to the angle rot_phi between the x --axis and the absolute frame X --axis.

Definition at line 208 of file base_vect_cart.C.

References rot_phi, and set_align().

Friends And Related Function Documentation

Base_vect* Base_vect::bvect_from_file ( FILE *   )  [friend]

The construction function from a file.

ostream& operator<< ( ostream &  ,
const Base_vect &   
) [friend, inherited]

Display.

Member Data Documentation

int Base_vect_cart::align [private]

Indicator of alignment with respect to the absolute frame: \ align = 1 : basis aligned with the absolute frame (${\tt rot\_phi = 0}$) \ align = -1 : basis anti-aligned with the absolute frame (${\tt rot\_phi} = \pi$) \ align = 0 : general case.

Definition at line 213 of file base_vect.h.

char Base_vect::name[100] [protected, inherited]

Name of the basis.

Definition at line 106 of file base_vect.h.

double Base_vect_cart::rot_phi [private]

Angle between the x --axis and the absolute frame X --axis.

Definition at line 203 of file base_vect.h.

The documentation for this class was generated from the following files:
Generated on 7 Oct 2014 for LORENE by  doxygen 1.6.1