criptic v1
Cosmic Ray Interstellar Propagation Tool using Itô Calculus
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
criptic::LocalNodeStruct_ Struct Reference

Struct representing a node of the local KD tree. More...

#include <CRTreeNode.H>

Public Member Functions

constexpr bool ext () const
 Flag if this node refers to packets on an external rank.
 
constexpr int rank () const
 Rank that owns the children of an external node.
 

Public Attributes

IdxType start
 
IdxType count
 
IdxType lchild
 
IdxType rchild
 
IdxType parent
 
IdxType order
 
int splitDim
 
Real splitVal
 
RealBox box
 
RealBox bnd
 
Real wSum
 
Real w2Sum
 
RealVec cm
 
RealTensor2 cov
 
FieldQty fQ [TREE_RIGIDITY_BINS]
 

Detailed Description

Struct representing a node of the local KD tree.

This structure represents a node of the local KD tree, which organizes the data within a single MPI rank.

Member Function Documentation

◆ ext()

constexpr bool criptic::LocalNodeStruct_::ext ( ) const
inlineconstexpr

Flag if this node refers to packets on an external rank.

Returns
True if this node refers to packets on an external rank

This routine returns true if and only if the this node in the tree has children, but those children reside on another MPI rank and thus this node cannot be opened on the local rank.

◆ rank()

constexpr int criptic::LocalNodeStruct_::rank ( ) const
inlineconstexpr

Rank that owns the children of an external node.

Returns
Rank that owns the children of an external node

The results are only meaningful if called on a node for which ext() returns true. Results are undefined if called on a node for which ext() returns false.

Member Data Documentation

◆ bnd

RealBox criptic::LocalNodeStruct_::bnd

Tight bounding box for node

◆ box

RealBox criptic::LocalNodeStruct_::box

Bounding box for node

◆ cm

RealVec criptic::LocalNodeStruct_::cm

Box "center of mass" determined by packet weights

◆ count

IdxType criptic::LocalNodeStruct_::count

Number of packets in this node

◆ cov

RealTensor2 criptic::LocalNodeStruct_::cov

CR packet-weighted covariance matrix

◆ fQ

FieldQty criptic::LocalNodeStruct_::fQ[TREE_RIGIDITY_BINS]

Total contribution of packets in a node to field quantities, counting only packets above specified rigidity values

◆ lchild

IdxType criptic::LocalNodeStruct_::lchild

Index of left child

◆ order

IdxType criptic::LocalNodeStruct_::order

Order of this leaf in a breadth-first traversal of the tree; set to null for non-leaf nodes

◆ parent

IdxType criptic::LocalNodeStruct_::parent

Index of parent

◆ rchild

IdxType criptic::LocalNodeStruct_::rchild

Index of right child

◆ splitDim

int criptic::LocalNodeStruct_::splitDim

Dimension along which node splits; a value of -1 indicates the node is a leaf

◆ splitVal

Real criptic::LocalNodeStruct_::splitVal

Value at which the node splits

◆ start

IdxType criptic::LocalNodeStruct_::start

Index of first packet in the node

◆ w2Sum

Real criptic::LocalNodeStruct_::w2Sum

Sum of squares of CR packet weights

◆ wSum

Real criptic::LocalNodeStruct_::wSum

Sum of CR packet weights


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