TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Joints_32_64< _SIZE_ > Class Template Reference

Joints class — represents a list of Joint objects. More...

#include <Joints.h>

Inheritance diagram for Joints_32_64< _SIZE_ >:
[legend]
Collaboration diagram for Joints_32_64< _SIZE_ >:
[legend]

Public Types

using int_t = _SIZE_
using Domaine_t = Domaine_32_64<_SIZE_>
using Joint_t = Joint_32_64<_SIZE_>

Public Member Functions

void associer_domaine (const Domaine_t &)
 Associates a domain with all joints in the list.
int_t nb_faces () const
 Returns the total number of faces in all Joints_32_64 in the list.
int_t nb_faces (Type_Face type) const
 Returns the number of faces of the specified type contained in the joint list.
int nb_joints () const
void comprimer ()
 Compresses the joint list by merging joints sharing the same neighboring PE.
Joint_tjoint_PE (int pe)
 Returns a reference to the joint whose neighboring PE is the specified one.

Detailed Description

template<typename _SIZE_>
class Joints_32_64< _SIZE_ >

Joints class — represents a list of Joint objects.

See also
Joint

Definition at line 27 of file Joints.h.

Member Typedef Documentation

◆ Domaine_t

template<typename _SIZE_>
using Joints_32_64< _SIZE_ >::Domaine_t = Domaine_32_64<_SIZE_>

Definition at line 34 of file Joints.h.

◆ int_t

template<typename _SIZE_>
using Joints_32_64< _SIZE_ >::int_t = _SIZE_

Definition at line 33 of file Joints.h.

◆ Joint_t

template<typename _SIZE_>
using Joints_32_64< _SIZE_ >::Joint_t = Joint_32_64<_SIZE_>

Definition at line 35 of file Joints.h.

Member Function Documentation

◆ associer_domaine()

template<typename _SIZE_>
void Joints_32_64< _SIZE_ >::associer_domaine ( const Domaine_t & un_domaine)

Associates a domain with all joints in the list.

The joints in the list will belong to this domain.

Parameters
un_domaineThe domain to associate with the joints.

Definition at line 33 of file Joints.cpp.

◆ comprimer()

template<typename _SIZE_>
void Joints_32_64< _SIZE_ >::comprimer ( )

Compresses the joint list by merging joints sharing the same neighboring PE.

Definition at line 75 of file Joints.cpp.

◆ joint_PE()

template<typename _SIZE_>
Joints_32_64< _SIZE_ >::Joint_t & Joints_32_64< _SIZE_ >::joint_PE ( int pe)

Returns a reference to the joint whose neighboring PE is the specified one.

Parameters
peA PE index.
Returns
Reference to the joint whose neighboring PE is pe.
Exceptions
Errorif the specified neighboring PE is not found in the joint list.

Definition at line 135 of file Joints.cpp.

◆ nb_faces() [1/2]

template<typename _SIZE_>
_SIZE_ Joints_32_64< _SIZE_ >::nb_faces ( ) const

Returns the total number of faces in all Joints_32_64 in the list.

This is the sum of faces over all joints in the list.

Returns
Total number of faces across all joints in the list.

Definition at line 45 of file Joints.cpp.

◆ nb_faces() [2/2]

template<typename _SIZE_>
_SIZE_ Joints_32_64< _SIZE_ >::nb_faces ( Type_Face type) const

Returns the number of faces of the specified type contained in the joint list.

This is the sum of faces of the given type over all joints in the list.

Parameters
typeThe face type to count.
Returns
Number of faces of the specified type contained in the joint list.

Definition at line 61 of file Joints.cpp.

◆ nb_joints()

template<typename _SIZE_>
int Joints_32_64< _SIZE_ >::nb_joints ( ) const
inline

Definition at line 40 of file Joints.h.


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