Kadath::List_comp Class Reference

Class for storing a list of tensorial components. More...

#include <list_comp.hpp>

Public Member Functions
	List_comp (int nc, int val)
	Standard constructor. More...
	List_comp (const List_comp &)
	Constructor by copy. More...
	~List_comp ()
	Destructor. More...
Array< int > *	set (int i)
	Read/write of one particular component. More...
Array< int > *	operator() (int i) const
	Read/write of one particular component. More...
int	get_ncomp () const
	Returns the number of components. More...
Array< int > **	get_pcomp () const
	Returns a pointer of the liste. More...

Protected Attributes
int	ncomp
	Number of stored components. More...
int	valence
	Number of indices for each component. More...
Array< int > **	pcomp
	Array of pointers on each componenent. More...

Detailed Description

Class for storing a list of tensorial components.

It simply consists of a list of integer Arrays. It is intended to be used when passing equations to a System_of_eqs

Definition at line 33 of file list_comp.hpp.

Constructor & Destructor Documentation

List_comp() [1/2]

Kadath::List_comp::List_comp	(	int	nc,
		int	val
	)

Standard constructor.

Parameters

nc	[input] number of components.
val	[input] valence of the components.

Definition at line 28 of file list_comp.cpp.

References ncomp, pcomp, and valence.

List_comp() [2/2]

Kadath::List_comp::List_comp

(

const List_comp &

so

)

Constructor by copy.

Definition at line 35 of file list_comp.cpp.

References ncomp, and pcomp.

~List_comp()

Kadath::List_comp::~List_comp

(

)

Destructor.

Definition at line 42 of file list_comp.cpp.

References ncomp, and pcomp.

Member Function Documentation

get_ncomp()

int Kadath::List_comp::get_ncomp ( ) const

inline

Returns the number of components.

Definition at line 64 of file list_comp.hpp.

References ncomp.

get_pcomp()

Array<int>** Kadath::List_comp::get_pcomp ( ) const

inline

Returns a pointer of the liste.

Definition at line 69 of file list_comp.hpp.

References pcomp.

operator()()

Array< int > * Kadath::List_comp::operator()

(

int

i

)

const

Read/write of one particular component.

Parameters

i	[input] which component.

Definition at line 57 of file list_comp.cpp.

References ncomp, and pcomp.

set()

Array< int > * Kadath::List_comp::set

(

int

i

)

Read/write of one particular component.

Parameters

i	[input] which component.

Definition at line 49 of file list_comp.cpp.

References ncomp, and pcomp.

Member Data Documentation

ncomp

int Kadath::List_comp::ncomp

protected

Number of stored components.

Definition at line 35 of file list_comp.hpp.

pcomp

Array<int>** Kadath::List_comp::pcomp

protected

Array of pointers on each componenent.

Definition at line 37 of file list_comp.hpp.

valence

int Kadath::List_comp::valence

protected

Number of indices for each component.

Definition at line 36 of file list_comp.hpp.

---

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

• list_comp.hpp
• list_comp.cpp