CmaUtils::PreCalculatedHydroState Class Reference

Structure to store hydrodynamic properties from a compartment mesh. More...

#include <cache_hydro_state.hpp>

Public Member Functions
	PreCalculatedHydroState ()
	Default constructor.
	~PreCalculatedHydroState ()=default
	Default destructor.
	PreCalculatedHydroState (const FlowMatrixType &_tm)
	Constructor initializing with a given flow matrix.
PreCalculatedHydroState &	operator= (PreCalculatedHydroState &&rhs)=default
	Default move constructor.
PreCalculatedHydroState &	operator= (const PreCalculatedHydroState &rhs)=delete
	Deleted copy constructor.
	PreCalculatedHydroState (PreCalculatedHydroState &&other)=default
	Default move assigment.
	PreCalculatedHydroState (const PreCalculatedHydroState &other)=delete
	Deleted copy assigment.
const FlowMatrixType &	get_transition () const
	Get the transition matrix.
DiagonalView< ComputeSpace >	get_kernel_diagonal () const
	Get the kernel diagonal view.

Public Attributes
FlowMatrixType	transition_matrix
	Matrix representing flow transitions.
Eigen::Matrix< double, -1, -1, Eigen::RowMajor >	cumulative_probability
	Cumulative probability matrix.
std::vector< double >	inverse_volume
	Inverse of compartment volumes.
std::vector< double >	volume
	Volumes of compartments.
DiagonalView< ComputeSpace >	diagonal_compute
	Diagonal view for compute operations.

Friends
class	ProxyCalculatedHydroState

Detailed Description

Structure to store hydrodynamic properties from a compartment mesh.

This class is populated during the reading and processing of a Compartment-Mesh case and is later accessed during transient simulations. The primary advantage is that it allows reusing precomputed states, eliminating the need to recalculate them from the mesh. Access and modification are performed via the ProxyCalculatedHydroState class, which ensures controlled interaction with the private members of this class.

Constructor & Destructor Documentation

PreCalculatedHydroState() [1/4]

CmaUtils::PreCalculatedHydroState::PreCalculatedHydroState

(

)

Default constructor.

~PreCalculatedHydroState()

CmaUtils::PreCalculatedHydroState::~PreCalculatedHydroState ( )

default

Default destructor.

PreCalculatedHydroState() [2/4]

CmaUtils::PreCalculatedHydroState::PreCalculatedHydroState ( const FlowMatrixType & _tm )

explicit

Constructor initializing with a given flow matrix.

Parameters

_tm	Reference to a FlowMatrixType object.

PreCalculatedHydroState() [3/4]

CmaUtils::PreCalculatedHydroState::PreCalculatedHydroState ( PreCalculatedHydroState && other )

default

Default move assigment.

PreCalculatedHydroState() [4/4]

CmaUtils::PreCalculatedHydroState::PreCalculatedHydroState ( const PreCalculatedHydroState & other )

delete

Deleted copy assigment.

Member Function Documentation

get_kernel_diagonal()

DiagonalView< ComputeSpace > CmaUtils::PreCalculatedHydroState::get_kernel_diagonal ( ) const

inlinenodiscard

Get the kernel diagonal view.

Returns

DiagonalView object for kernel computation.

Here is the caller graph for this function:

get_transition()

const FlowMatrixType & CmaUtils::PreCalculatedHydroState::get_transition ( ) const

nodiscard

Get the transition matrix.

Returns

Constant reference to FlowMatrixType.

Here is the caller graph for this function:

operator=() [1/2]

PreCalculatedHydroState & CmaUtils::PreCalculatedHydroState::operator= ( const PreCalculatedHydroState & rhs )

delete

Deleted copy constructor.

operator=() [2/2]

PreCalculatedHydroState & CmaUtils::PreCalculatedHydroState::operator= ( PreCalculatedHydroState && rhs )

default

Default move constructor.

Friends And Related Symbol Documentation

ProxyCalculatedHydroState

friend class ProxyCalculatedHydroState

friend

Member Data Documentation

cumulative_probability

Eigen::Matrix<double, -1, -1, Eigen::RowMajor> CmaUtils::PreCalculatedHydroState::cumulative_probability

Cumulative probability matrix.

diagonal_compute

DiagonalView<ComputeSpace> CmaUtils::PreCalculatedHydroState::diagonal_compute

Diagonal view for compute operations.

inverse_volume

std::vector<double> CmaUtils::PreCalculatedHydroState::inverse_volume

Inverse of compartment volumes.

transition_matrix

FlowMatrixType CmaUtils::PreCalculatedHydroState::transition_matrix

Matrix representing flow transitions.

volume

std::vector<double> CmaUtils::PreCalculatedHydroState::volume

Volumes of compartments.

---

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

• apps/libs/cma_utils/public/cma_utils/cache_hydro_state.hpp
• apps/libs/cma_utils/src/cache_hydro_state.cpp