Structural rank analysis of selected outputs with respect to one input block. More...

#include <Diagnostics.hpp>

Collaboration diagram for janus::StructuralSensitivityReport:

Public Member Functions
bool	full_rank () const
	Check if the Jacobian has full structural rank.

Public Attributes
StructuralProperty	property = StructuralProperty::Observability
	Analysis type.
int	input_idx = -1
	Analyzed input block index.
std::string	input_name
	Name of the input block.
std::vector< int >	output_indices
	Selected output indices.
std::vector< std::string >	output_names
	Names of selected outputs.
int	variable_dimension = 0
	Number of scalar variables.
int	output_dimension = 0
	Number of scalar outputs.
int	structural_rank = 0
	Structural rank of Jacobian.
int	rank_deficiency = 0
	variable_dimension - structural_rank
SparsityPattern	sensitivity_sparsity
	Jacobian sparsity pattern.
std::vector< DiagnosticInputRef >	inputs
	Per-element input metadata.
std::vector< DiagnosticOutputRef >	outputs
	Per-element output metadata.
std::vector< int >	deficient_local_indices
	All structurally deficient inputs.
std::vector< int >	zero_sensitivity_local_indices
	Inputs with zero Jacobian columns.
std::vector< StructuralDeficiencyGroup >	deficiency_groups
	Connected deficient components.
std::vector< StructuralDiagnosticIssue >	issues
	User-facing diagnostic messages.

Detailed Description

Structural rank analysis of selected outputs with respect to one input block.

Member Function Documentation

◆ full_rank()

bool janus::StructuralSensitivityReport::full_rank ( ) const

inline

Check if the Jacobian has full structural rank.

Returns: true if rank_deficiency == 0

Member Data Documentation

◆ deficiency_groups

std::vector<StructuralDeficiencyGroup> janus::StructuralSensitivityReport::deficiency_groups

Connected deficient components.

◆ deficient_local_indices

std::vector<int> janus::StructuralSensitivityReport::deficient_local_indices

All structurally deficient inputs.

◆ input_idx

int janus::StructuralSensitivityReport::input_idx = -1

Analyzed input block index.

◆ input_name

std::string janus::StructuralSensitivityReport::input_name

Name of the input block.

◆ inputs

std::vector<DiagnosticInputRef> janus::StructuralSensitivityReport::inputs

Per-element input metadata.

◆ issues

std::vector<StructuralDiagnosticIssue> janus::StructuralSensitivityReport::issues

User-facing diagnostic messages.

◆ output_dimension

int janus::StructuralSensitivityReport::output_dimension = 0

Number of scalar outputs.

◆ output_indices

std::vector<int> janus::StructuralSensitivityReport::output_indices

Selected output indices.

◆ output_names

std::vector<std::string> janus::StructuralSensitivityReport::output_names

Names of selected outputs.

◆ outputs

std::vector<DiagnosticOutputRef> janus::StructuralSensitivityReport::outputs

Per-element output metadata.

◆ property

StructuralProperty janus::StructuralSensitivityReport::property = StructuralProperty::Observability

Analysis type.

◆ rank_deficiency

int janus::StructuralSensitivityReport::rank_deficiency = 0

variable_dimension - structural_rank

◆ sensitivity_sparsity

SparsityPattern janus::StructuralSensitivityReport::sensitivity_sparsity

Jacobian sparsity pattern.

◆ structural_rank

int janus::StructuralSensitivityReport::structural_rank = 0

Structural rank of Jacobian.

◆ variable_dimension

int janus::StructuralSensitivityReport::variable_dimension = 0

Number of scalar variables.

◆ zero_sensitivity_local_indices

std::vector<int> janus::StructuralSensitivityReport::zero_sensitivity_local_indices

Inputs with zero Jacobian columns.

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

include/janus/core/Diagnostics.hpp

Public Member Functions

Public Attributes