SCIANTIX API reference

Class Hierarchy

• • Class Gas
  • Class InputVariable
  • Class Material
  • Class Matrix
  • Class Model
  • Template Class SciantixArray
  • Class SciantixVariable
  • Class Simulation
  • Class Solver
  • Class System
  • Class Variable

File Hierarchy

• • Directory include
    • Directory classes
      • File Gas.h
      • File InputVariable.h
      • File Material.h
      • File Matrix.h
      • File Model.h
      • File SciantixArray.h
      • File SciantixVariable.h
      • File Simulation.h
      • File Solver.h
      • File System.h
      • File Variable.h
    • Directory coupling
      • File TUSrcCoupling.h
    • Directory file_manager
      • File Initialization.h
      • File InputInterpolation.h
      • File InputReading.h
      • File TimeStepCalculation.h
    • Directory models
      • File GasDiffusion.h
      • File StoichiometryDeviation.h
    • Directory namespaces
      • File Constants.h
      • File ErrorMessages.h
    • Directory operations
      • File SetGas.h
      • File SetGPVariables.h
      • File SetMatrix.h
      • File SetSystem.h
      • File SetVariables.h
      • File SetVariablesFunctions.h
    • File MainVariables.h
    • File Sciantix.h

Full API

Namespaces

• Namespace ErrorMessages
  • Detailed Description
  • Functions

Classes and Structs

• Class Gas
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Gas
      • setAtomicNumber()
      • getAtomicNumber()
      • setMassNumber()
      • getMassNumber()
      • setVanDerWaalsVolume()
      • getVanDerWaalsVolume()
      • setDecayRate()
      • getDecayRate()
      • setPrecursorFactor()
      • getPrecursorFactor()
      • Gas()
      • ~Gas()
      • atomic_number
      • mass_number
      • van_der_waals_volume
      • decay_rate
      • precursor_factor

• Class InputVariable
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • InputVariable
      • InputVariable()
      • setValue()
      • getValue()
      • InputVariable()
      • ~InputVariable()
      • value

• Class Material
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Material
      • Material()
      • ~Material()
      • setName()
      • getName()
      • setRef()
      • getRef()
      • name
      • reference

• Class Matrix
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Matrix
      • setTheoreticalDensity()
      • getTheoreticalDensity()
      • setLatticeParameter()
      • getLatticeParameter()
      • setSurfaceTension()
      • getSurfaceTension()
      • setSchottkyVolume()
      • getSchottkyVolume()
      • setOctahedralInterstitialSite()
      • getOctahedralInterstitialSite()
      • setGrainBoundaryMobility()
      • getGrainBoundaryMobility()
      • setFissionFragmentRange()
      • getFissionFragmentRange()
      • setFissionFragmentInfluenceRadius()
      • getFissionFragmentInfluenceRadius()
      • setSemidihedralAngle()
      • getSemidihedralAngle()
      • setGrainBoundaryThickness()
      • getGrainBoundaryThickness()
      • setGrainBoundaryVacancyDiffusivity()
      • getGrainBoundaryVacancyDiffusivity()
      • setLenticularShapeFactor()
      • getLenticularShapeFactor()
      • setNucleationRate()
      • getNucleationRate()
      • setPoreNucleationRate()
      • getPoreNucleationRate()
      • setPoreResolutionRate()
      • getPoreResolutionRate()
      • setPoreTrappingRate()
      • getPoreTrappingRate()
      • setGrainRadius()
      • getGrainRadius()
      • setHealingTemperatureThreshold()
      • getHealingTemperatureThreshold()
      • setChromiumContent()
      • getChromiumContent()
      • setChromiumSolubility()
      • getChroimumSolubility()
      • setChromiaSolubility()
      • getChromiaSolubility()
      • setChromiumSolution()
      • getChromiumSolution()
      • setChromiumPrecipitate()
      • getChromiumPrecipitate()
      • setChromiaSolution()
      • getChromiaSolution()
      • setChromiaPrecipitate()
      • getChromiaPrecipitate()
      • setElasticModulus()
      • getElasticModulus()
      • setPoissonRatio()
      • getPoissonRatio()
      • setGrainBoundaryFractureEnergy()
      • getGrainBoundaryFractureEnergy()
      • setShearModulus()
      • getShearModulus()
      • Matrix()
      • ~Matrix()
      • matrix_density
      • lattice_parameter
      • grain_boundary_mobility
      • ff_range
      • ff_influence_radius
      • surface_tension
      • schottky_defect_volume
      • ois_volume
      • grain_boundary_thickness
      • grain_boundary_diffusivity
      • semidihedral_angle
      • lenticular_shape_factor
      • grain_radius
      • healing_temperature_threshold
      • nucleation_rate
      • pore_nucleation_rate
      • pore_resolution_rate
      • pore_trapping_rate
      • chromium_content
      • chromium_solubility
      • Cr2O3_solubility
      • chromium_solution
      • chromium_precipitate
      • chromia_solution
      • chromia_precipitate
      • elastic_modulus
      • poisson_ratio
      • grain_boundary_fracture_energy
      • shear_modulus

• Class Model
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Model
      • setParameter()
      • getParameter()
      • Model()
      • ~Model()
      • overview
      • parameter

• Template Class SciantixArray
  • Class Documentation
    • SciantixArray
      • SciantixArray()
      • ~SciantixArray()
      • SciantixArray()
      • push()
      • clear()
      • empty()
      • operator[]()
      • operator[]()
      • begin()
      • end()
      • begin()
      • end()
      • isElementPresent()

• Class SciantixVariable
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • SciantixVariable
      • SciantixVariable()
      • rescaleInitialValue()
      • rescaleFinalValue()
      • addValue()
      • setUOM()
      • getUOM()
      • setConstant()
      • resetValue()
      • setFinalValue()
      • setInitialValue()
      • getFinalValue()
      • getInitialValue()
      • getIncrement()
      • setOutput()
      • getOutput()
      • SciantixVariable()
      • ~SciantixVariable()
      • uom
      • final_value
      • initial_value
      • to_output

• Class Simulation
  • Class Documentation
    • Simulation
      • ~Simulation()
      • setVariables()
      • setGas()
      • setMatrix()
      • setSystem()
      • setGPVariables()
      • initialize()
      • execute()
      • update()
      • output()
      • Burnup()
      • EffectiveBurnup()
      • GasProduction()
      • GasDecay()
      • GasRelease()
      • GasDiffusion()
      • GrainGrowth()
      • IntraGranularBubbleBehavior()
      • InterGranularBubbleBehavior()
      • GrainBoundarySweeping()
      • GrainBoundaryMicroCracking()
      • Densification()
      • GrainBoundaryVenting()
      • openPorosity()
      • athermalVentingFactor()
      • HighBurnupStructureFormation()
      • HighBurnupStructurePorosity()
      • StoichiometryDeviation()
      • GapPartialPressure()
      • UO2Thermochemistry()
      • ChromiumSolubility()
      • Microstructure()
      • getDiffusionModes()
      • getDiffusionModesSolution()
      • getDiffusionModesBubbles()
      • getInstance()

• Class Solver
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Solver
      • Integrator()
      • LimitedGrowth()
      • Decay()
      • BinaryInteraction()
      • SpectralDiffusion()
      • dotProduct1D()
      • dotProduct2D()
      • SpectralDiffusion2equations()
      • SpectralDiffusion3equations()
      • Laplace2x2()
      • Laplace3x3()
      • det()
      • Laplace()
      • QuarticEquation()
      • modeInitialization()
      • NewtonBlackburn()
      • NewtonLangmuirBasedModel()
      • Solver()
      • ~Solver()

• Class System
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • System
      • setRestructuredMatrix()
      • getRestructuredMatrix()
      • setYield()
      • getYield()
      • setRadiusInLattice()
      • getRadiusInLattice()
      • setGas()
      • getGas()
      • getGasName()
      • setMatrix()
      • getMatrix()
      • getMatrixName()
      • getVolumeInLattice()
      • setVolumeInLattice()
      • setBubbleDiffusivity()
      • getBubbleDiffusivity()
      • setHeliumDiffusivity()
      • getHeliumDiffusivity()
      • setFissionGasDiffusivity()
      • getFissionGasDiffusivity()
      • setHenryConstant()
      • getHenryConstant()
      • setResolutionRate()
      • getResolutionRate()
      • setTrappingRate()
      • getTrappingRate()
      • setNucleationRate()
      • getNucleationRate()
      • setPoreNucleationRate()
      • getPoreNucleationRate()
      • setProductionRate()
      • getProductionRate()
      • System()
      • ~System()
      • reference
      • name
      • yield
      • radius_in_lattice
      • volume_in_lattice
      • diffusivity
      • bubble_diffusivity
      • henry_constant
      • resolution_rate
      • trapping_rate
      • nucleation_rate
      • pore_nucleation_rate
      • modes
      • production_rate
      • restructured_matrix
      • gas
      • matrix

• Class Variable
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Variable
      • Variable()
      • ~Variable()
      • setName()
      • getName()
      • name

Functions

• Function BlackburnThermochemicalModel
  • Function Documentation
    • BlackburnThermochemicalModel()

• Function callSciantix
  • Function Documentation

• Function defineSpectralDiffusion1Equation
  • Function Documentation
    • defineSpectralDiffusion1Equation()

• Function defineSpectralDiffusion2Equations
  • Function Documentation
    • defineSpectralDiffusion2Equations()

• Function defineSpectralDiffusion3Equations
  • Function Documentation
    • defineSpectralDiffusion3Equations()

• Function errorHandling
  • Function Documentation
    • errorHandling()

• Function ErrorMessages::MissingInputFile
  • Function Documentation
    • MissingInputFile()

• Function ErrorMessages::Switch
  • Function Documentation
    • Switch()

• Function ErrorMessages::writeErrorLog
  • Function Documentation
    • writeErrorLog()

• Function getInputVariableNames
  • Function Documentation
    • getInputVariableNames()

• Function getScalingFactorsNames
  • Function Documentation
    • getScalingFactorsNames()

• Function getSciantixOptions
  • Function Documentation

• Function He_in_UO2
  • Function Documentation
    • He_in_UO2()

• Function helium
  • Function Documentation
    • helium()

• Function Initialization
  • Function Documentation

• Function initializeHistoryVariable
  • Function Documentation

• Function initializeSciantixVariable
  • Function Documentation

• Function InputInterpolation
  • Function Documentation
    • InputInterpolation()

• Function InputReading
  • Function Documentation

• Function Kr85m_in_UO2
  • Function Documentation
    • Kr85m_in_UO2()

• Function Kr_in_UO2
  • Function Documentation
    • Kr_in_UO2()

• Function krypton
  • Function Documentation
    • krypton()

• Function ReadOneParameter
  • Function Documentation
    • ReadOneParameter()

• Function ReadOneSetting
  • Function Documentation
    • ReadOneSetting()

• Function Sciantix
  • Function Documentation

• Function SetGPVariables
  • Function Documentation

• Function SetVariables
  • Function Documentation

• Function TimeStepCalculation
  • Function Documentation
    • TimeStepCalculation()

• Function UO2
  • Function Documentation
    • UO2()

• Function UO2HBS
  • Function Documentation
    • UO2HBS()

• Function Xe133_in_UO2
  • Function Documentation
    • Xe133_in_UO2()

• Function Xe_in_UO2
  • Function Documentation
    • Xe_in_UO2()

• Function Xe_in_UO2HBS
  • Function Documentation
    • Xe_in_UO2HBS()

• Function xenon
  • Function Documentation
    • xenon()

Variables

• Variable avogadro_number
  • Variable Documentation
    • avogadro_number

• Variable boltzmann_constant
  • Variable Documentation
    • boltzmann_constant

• Variable boltzmann_constant_eV
  • Variable Documentation
    • boltzmann_constant_eV

• Variable calorie
  • Variable Documentation
    • calorie

• Variable dTime_h
  • Variable Documentation
    • dTime_h

• Variable Execution_file
  • Variable Documentation
    • Execution_file

• Variable Fissionrate_input
  • Variable Documentation
    • Fissionrate_input

• Variable Fissionrate_input_points
  • Variable Documentation
    • Fissionrate_input_points

• Variable gas_constant
  • Variable Documentation
    • gas_constant

• Variable Hydrostaticstress_input
  • Variable Documentation
    • Hydrostaticstress_input

• Variable Hydrostaticstress_input_points
  • Variable Documentation
    • Hydrostaticstress_input_points

• Variable Input_history_points
  • Variable Documentation
    • Input_history_points

• Variable molar_mass_Chromium
  • Variable Documentation
    • molar_mass_Chromium

• Variable molar_mass_Oxygen
  • Variable Documentation
    • molar_mass_Oxygen

• Variable Number_of_time_steps_per_interval
  • Variable Documentation
    • Number_of_time_steps_per_interval

• Variable Output_file
  • Variable Documentation
    • Output_file

• Variable Sciantix_diffusion_modes
  • Variable Documentation
    • Sciantix_diffusion_modes

• Variable Sciantix_history
  • Variable Documentation
    • Sciantix_history

• Variable Sciantix_options
  • Variable Documentation
    • Sciantix_options

• Variable Sciantix_scaling_factors
  • Variable Documentation
    • Sciantix_scaling_factors

• Variable Sciantix_variables
  • Variable Documentation
    • Sciantix_variables

• Variable Steampressure_input
  • Variable Documentation
    • Steampressure_input

• Variable Stempressure_input_points
  • Variable Documentation
    • Stempressure_input_points

• Variable Temperature_input
  • Variable Documentation
    • Temperature_input

• Variable Temperature_input_points
  • Variable Documentation
    • Temperature_input_points

• Variable TestPath
  • Variable Documentation
    • TestPath

• Variable Time_end_h
  • Variable Documentation
    • Time_end_h

• Variable Time_end_s
  • Variable Documentation
    • Time_end_s

• Variable Time_fissionrate_input
  • Variable Documentation
    • Time_fissionrate_input

• Variable Time_h
  • Variable Documentation
    • Time_h

• Variable Time_hydrostaticstress_input
  • Variable Documentation
    • Time_hydrostaticstress_input

• Variable Time_input
  • Variable Documentation
    • Time_input

• Variable Time_s
  • Variable Documentation
    • Time_s

• Variable Time_steampressure_input
  • Variable Documentation
    • Time_steampressure_input

• Variable Time_step_number
  • Variable Documentation
    • Time_step_number

• Variable Time_temperature_input
  • Variable Documentation
    • Time_temperature_input