KADATH
Public Member Functions | Protected Attributes | Friends | List of all members
Kadath::Param_tensor Class Reference
Physical fields.

Class for handling additional parameters for some Tensor. More...

#include <tensor.hpp>

Inheritance diagram for Kadath::Param_tensor:

Public Member Functions

int get_m_order () const
 Returns $m_{\rm order}$. More...
 
int & set_m_order ()
 Sets $m_{\rm order}$. More...
 
int get_m_quant () const
 Returns $m_{\rm quant}$. More...
 
int & set_m_quant ()
 Sets $m_{\rm quant}$. More...
 
void swap (Param_tensor &so) noexcept
 Sylvain's stuff. More...
 
 operator bool () const noexcept
 Check of some parameters are affected. More...
 
bool operator! () const noexcept
 Check if the parameters are not affected. More...
 

Protected Attributes

bool m_order_affected
 States if the parameter $m_{\rm order}$ is affected. More...
 
int m_order
 The value of $m_{\rm order}$, if affected. More...
 
bool m_quant_affected
 States if the parameter $m_{\rm quant}$ is affected. More...
 
int m_quant
 The value of $m_{\rm quant}$, if affected. More...
 

Friends

class Tensor
 
int add_m_quant (const Param_tensor &, const Param_tensor &)
 Addition quantum numbers. More...
 
int mult_m_quant (const Param_tensor &, const Param_tensor &)
 Multiplication of quantum numbers. More...
 
int div_m_quant (const Param_tensor &, const Param_tensor &)
 Division of quantum numbers. More...
 
int inv_m_quant (const Param_tensor &)
 Inverse of a quantum number. More...
 

Detailed Description

Class for handling additional parameters for some Tensor.

It can, for instance, store the winding number of the scalar field of a boson star.

Definition at line 105 of file tensor.hpp.

Member Function Documentation

◆ get_m_order()

int Kadath::Param_tensor::get_m_order ( ) const
inline

Returns $m_{\rm order}$.

Definition at line 737 of file tensor.hpp.

References m_order, and m_order_affected.

◆ get_m_quant()

int Kadath::Param_tensor::get_m_quant ( ) const
inline

Returns $m_{\rm quant}$.

Definition at line 747 of file tensor.hpp.

References m_quant, and m_quant_affected.

◆ operator bool()

Kadath::Param_tensor::operator bool ( ) const
inlinenoexcept

Check of some parameters are affected.

Definition at line 124 of file tensor.hpp.

References m_order_affected, and m_quant_affected.

◆ operator!()

bool Kadath::Param_tensor::operator! ( ) const
inlinenoexcept

Check if the parameters are not affected.

Definition at line 127 of file tensor.hpp.

References m_order_affected, and m_quant_affected.

◆ set_m_order()

int & Kadath::Param_tensor::set_m_order ( )
inline

Sets $m_{\rm order}$.

Definition at line 762 of file tensor.hpp.

References m_order, and m_order_affected.

◆ set_m_quant()

int & Kadath::Param_tensor::set_m_quant ( )
inline

Sets $m_{\rm quant}$.

Definition at line 757 of file tensor.hpp.

References m_quant, and m_quant_affected.

◆ swap()

void Kadath::Param_tensor::swap ( Param_tensor &  so)
inlinenoexcept

Sylvain's stuff.

Definition at line 767 of file tensor.hpp.

Friends And Related Function Documentation

◆ add_m_quant

int add_m_quant ( const Param_tensor &  aa,
const Param_tensor &  bb 
)
friend

Addition quantum numbers.

Definition at line 23 of file param_tensor.cpp.

◆ div_m_quant

int div_m_quant ( const Param_tensor &  aa,
const Param_tensor &  bb 
)
friend

Division of quantum numbers.

Definition at line 43 of file param_tensor.cpp.

◆ inv_m_quant

int inv_m_quant ( const Param_tensor &  aa)
friend

Inverse of a quantum number.

Definition at line 54 of file param_tensor.cpp.

◆ mult_m_quant

int mult_m_quant ( const Param_tensor &  aa,
const Param_tensor &  bb 
)
friend

Multiplication of quantum numbers.

Definition at line 32 of file param_tensor.cpp.

Member Data Documentation

◆ m_order

int Kadath::Param_tensor::m_order
protected

The value of $m_{\rm order}$, if affected.

Definition at line 109 of file tensor.hpp.

◆ m_order_affected

bool Kadath::Param_tensor::m_order_affected
protected

States if the parameter $m_{\rm order}$ is affected.

Definition at line 108 of file tensor.hpp.

◆ m_quant

int Kadath::Param_tensor::m_quant
protected

The value of $m_{\rm quant}$, if affected.

Definition at line 111 of file tensor.hpp.

◆ m_quant_affected

bool Kadath::Param_tensor::m_quant_affected
protected

States if the parameter $m_{\rm quant}$ is affected.

Definition at line 110 of file tensor.hpp.

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