Result description reference

The result of the simulation with respect to specific quantities at concrete points can be tested against particular values with a given tolerance.

-------------------------------------------------RESULT DESCRIPTION
// <one_of>:
//   STRUCTURE:
//     <one_of>:
//       <all_of>:
//         DIS <string>
//         NODE <int>
//       <all_of>:
//         DIS <string>
//         LINE <int>
//       <all_of>:
//         DIS <string>
//         SURFACE <int>
//       <all_of>:
//         DIS <string>
//         VOLUME <int>
//       SPECIAL <bool>
//     OP <TestOp> (default: unknown)
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   FLUID:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       ELEMENT <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   XFLUID:
//     DIS <string>
//     NODE <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   ALE:
//     DIS <string>
//     NODE <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   THERMAL:
//     DIS <string>
//     NODE <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   LUBRICATION:
//     DIS <string>
//     NODE <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   POROFLUIDMULTIPHASE:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       ELEMENT <int>
//       SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   SCATRA:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   SSI:
//     <one_of>:
//       <all_of>:
//         DIS <string>
//         NODE <int>
//       SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   SSTI:
//     SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   STI:
//     SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   RED_AIRWAY:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       ELEMENT <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   ARTNET:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       ELEMENT <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   FSI:
//     <one_of>:
//       NODE <int>
//       SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   PARTICLE:
//     ID <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   PARTICLEWALL:
//     DIS <string>
//     <one_of>:
//       NODE <int>
//       SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   RIGIDBODY:
//     ID <int>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)
//   CARDIOVASCULAR0D:
//     DIS <string>
//     SPECIAL <bool>
//     QUANTITY <string>
//     VALUE <double>
//     TOLERANCE <double>
//     NAME <std::optional<string>> (default: none)

Functions reference

Definition of functions for various cases, mainly boundary conditions

--------------------------------------------------------------FUNCT
// <one_of>:
//   <one_of>:
//     <all_of>:
//       COMPONENT <std::optional<int>> (default: none)
//       SYMBOLIC_FUNCTION_OF_SPACE_TIME <string>
//     SYMBOLIC_FUNCTION_OF_TIME <string>
//     <all_of>:
//       VARIABLE <int>
//       NAME <string>
//       TYPE (choices: expression)
//       DESCRIPTION <string>
//       PERIODIC:
//         T1 <double>
//         T2 <double>
//     <all_of>:
//       VARIABLE <int>
//       NAME <string>
//       TYPE (choices: fourierinterpolation|linearinterpolation)
//       NUMPOINTS <int>
//       BYNUM:
//         TIMERANGE <vector<double>>
//       VALUES <vector<double>>
//       PERIODIC:
//         T1 <double>
//         T2 <double>
//     <all_of>:
//       VARIABLE <int>
//       NAME <string>
//       TYPE (choices: fourierinterpolation|linearinterpolation)
//       NUMPOINTS <int>
//       TIMES <vector<double>>
//       VALUES <vector<double>>
//       PERIODIC:
//         T1 <double>
//         T2 <double>
//     <all_of>:
//       VARIABLE <int>
//       NAME <string>
//       TYPE (choices: multifunction)
//       NUMPOINTS <int>
//       BYNUM:
//         TIMERANGE <vector<double>>
//       DESCRIPTION <vector<string>>
//       PERIODIC:
//         T1 <double>
//         T2 <double>
//     <all_of>:
//       VARIABLE <int>
//       NAME <string>
//       TYPE (choices: multifunction)
//       NUMPOINTS <int>
//       TIMES <vector<double>>
//       DESCRIPTION <vector<string>>
//       PERIODIC:
//         T1 <double>
//         T2 <double>
//     <all_of>:
//       VARFUNCTION <string>
//       NUMCONSTANTS <std::optional<int>> (default: none)
//       CONSTANTS <map<string, double>> (default: )
//   <one_of>:
//     WEAKLYCOMPRESSIBLE_ETIENNE_FSI_STRUCTURE:
//       MAT_STRUCT <int>
//     WEAKLYCOMPRESSIBLE_ETIENNE_FSI_STRUCTURE_FORCE:
//       MAT_STRUCT <int>
//   <one_of>:
//     <all_of>:
//       FLUID_FUNCTION (choices: BELTRAMI)
//       c1 <double>
//     FLUID_FUNCTION (choices: CHANNELWEAKLYCOMPRESSIBLE|CORRECTIONTERMCHANNELWEAKLYCOMPRESSIBLE)
//     <all_of>:
//       FLUID_FUNCTION (choices: WEAKLYCOMPRESSIBLE_POISEUILLE|WEAKLYCOMPRESSIBLE_POISEUILLE_FORCE)
//       MAT <int>
//       L <double>
//       R <double>
//       U <double>
//     <all_of>:
//       FLUID_FUNCTION (choices: WEAKLYCOMPRESSIBLE_ETIENNE_CFD|WEAKLYCOMPRESSIBLE_ETIENNE_CFD_FORCE|WEAKLYCOMPRESSIBLE_ETIENNE_CFD_VISCOSITY|WEAKLYCOMPRESSIBLE_MANUFACTUREDFLOW|WEAKLYCOMPRESSIBLE_MANUFACTUREDFLOW_FORCE)
//       MAT <int>
//     <all_of>:
//       FLUID_FUNCTION (choices: WEAKLYCOMPRESSIBLE_ETIENNE_FSI_FLUID|WEAKLYCOMPRESSIBLE_ETIENNE_FSI_FLUID_FORCE|WEAKLYCOMPRESSIBLE_ETIENNE_FSI_FLUID_VISCOSITY)
//       MAT_FLUID <int>
//       MAT_STRUCT <int>
//     <all_of>:
//       FLUID_FUNCTION (choices: BELTRAMI-GRADU|BELTRAMI-UP|KIMMOIN-GRADU|KIMMOIN-UP)
//       MAT <int>
//       ISSTAT <int>
//     <all_of>:
//       FLUID_FUNCTION (choices: BELTRAMI-RHS|KIMMOIN-RHS)
//       MAT <int>
//       ISSTAT <int>
//       ISSTOKES <int>
//     <all_of>:
//       FLUID_FUNCTION (choices: KIMMOIN-STRESS)
//       MAT <int>
//       ISSTAT <int>
//       AMPLITUDE <double>
//   COMBUSTION_FUNCTION (choices: COLLAPSINGWATERCOLUMN|ZALESAKSDISK)
//   <one_of>:
//     XFLUID_FUNCTION (choices: FORWARDFACINGSTEP)
//     <all_of>:
//       XFLUID_FUNCTION (choices: MOVINGLEVELSETCYLINDER)
//       ORIGIN <vector<double>>
//       RADIUS <double>
//       DIRECTION <vector<double>>
//       DISTANCE <double>
//       MAXSPEED <double>
//     <all_of>:
//       XFLUID_FUNCTION (choices: MOVINGLEVELSETTORUS|MOVINGLEVELSETTORUSVELOCITY)
//       ORIGIN <vector<double>>
//       ORIENTVEC_TORUS <vector<double>>
//       RADIUS <double>
//       RADIUS_TUBE <double>
//       DIRECTION <vector<double>>
//       DISTANCE <double>
//       MAXSPEED <double>
//       ROTATION_VEC <vector<double>>
//       ROTATION_SPEED <double>
//       ROTATION_RAMPTIME <double>
//     <all_of>:
//       XFLUID_FUNCTION (choices: MOVINGLEVELSETTORUSSLIPLENGTH)
//       ORIGIN <vector<double>>
//       ORIENTVEC_TORUS <vector<double>>
//       RADIUS <double>
//       RADIUS_TUBE <double>
//       DIRECTION <vector<double>>
//       DISTANCE <double>
//       MAXSPEED <double>
//       ROTATION_VEC <vector<double>>
//       ROTATION_SPEED <double>
//       ROTATION_RAMPTIME <double>
//       SLIP_FUNCT <int>
//     <all_of>:
//       XFLUID_FUNCTION (choices: TAYLORCOUETTEFLOW)
//       RADIUS_I <double>
//       RADIUS_O <double>
//       VEL_THETA_I <double>
//       VEL_THETA_O <double>
//       SLIPLENGTH_I <double>
//       SLIPLENGTH_O <double>
//       TRACTION_THETA_I <double>
//       TRACTION_THETA_O <double>
//       VISCOSITY <double>
//     <all_of>:
//       XFLUID_FUNCTION (choices: URQUIZABOXFLOW|URQUIZABOXFLOW_FORCE|URQUIZABOXFLOW_TRACTION)
//       LENGTHX <double>
//       LENGTHY <double>
//       ROTATION <double>
//       VISCOSITY <double>
//       DENSITY <double>
//       CASE <int>
//       COMBINATION <vector<double>>
//   <one_of>:
//     FASTPOLYNOMIAL:
//       NUMCOEFF <int>
//       COEFF <vector<double>>
//     CUBIC_SPLINE_FROM_CSV:
//       CSV <path>
//   <one_of>:
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: TUMOR_GROWTH_LAW_HEAVISIDE|TUMOR_GROWTH_LAW_HEAVISIDE_NECRO|TUMOR_GROWTH_LAW_HEAVISIDE_OXY)
//       PARAMS:
//         gamma_T_growth <double>
//         w_nl_crit <double>
//         w_nl_env <double>
//         lambda <double> (default: 0)
//         p_t_crit <double> (default: 1e+09)
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: NECROSIS_LAW_HEAVISIDE)
//       PARAMS:
//         gamma_t_necr <double>
//         w_nl_crit <double>
//         w_nl_env <double>
//         delta_a_t <double> (default: 0)
//         p_t_crit <double> (default: 1e+09)
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: OXYGEN_CONSUMPTION_LAW_HEAVISIDE)
//       PARAMS:
//         gamma_nl_growth <double>
//         gamma_0_nl <double>
//         w_nl_crit <double>
//         w_nl_env <double>
//         p_t_crit <double> (default: 1e+09)
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: OXYGEN_TRANSVASCULAR_EXCHANGE_LAW_CONT)
//       PARAMS:
//         n <double>
//         Pb50 <double>
//         CaO2_max <double>
//         alpha_bl_eff <double>
//         gamma_rho_SV <double>
//         rho_oxy <double>
//         rho_IF <double>
//         rho_bl <double>
//         alpha_IF <double>
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: OXYGEN_TRANSVASCULAR_EXCHANGE_LAW_DISC)
//       PARAMS:
//         n <double>
//         Pb50 <double>
//         CaO2_max <double>
//         alpha_bl_eff <double>
//         gamma_rho <double>
//         rho_oxy <double>
//         rho_IF <double>
//         rho_bl <double>
//         S2_max <double>
//         alpha_IF <double>
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: LUNG_OXYGEN_EXCHANGE_LAW)
//       PARAMS:
//         rho_oxy <double>
//         DiffAdVTLC <double>
//         alpha_oxy <double>
//         rho_air <double>
//         rho_bl <double>
//         n <double>
//         P_oB50 <double>
//         NC_Hb <double>
//         P_atmospheric <double>
//         volfrac_blood_ref <double>
//     <all_of>:
//       POROMULTIPHASESCATRA_FUNCTION (choices: LUNG_CARBONDIOXIDE_EXCHANGE_LAW)
//       PARAMS:
//         rho_CO2 <double>
//         DiffsolAdVTLC <double>
//         pH <double>
//         rho_air <double>
//         rho_bl <double>
//         rho_oxy <double>
//         n <double>
//         P_oB50 <double>
//         C_Hb <double>
//         NC_Hb <double>
//         alpha_oxy <double>
//         P_atmospheric <double>
//         ScalingFormmHg <double>
//         volfrac_blood_ref <double>
//   SCATRA_FUNCTION:
//     type <ScatraFunctionType>
//     parameters:
//       magnet_radius <double> "Radius of the cylinder magnet"
//       magnet_length <double> "Length of the cylinder magnet"
//       magnetic_permeability <double> "Magnetic permeability"
//       magnet_magnetization <double> "Magnetization of the cylinder magnet"
//       magnet_position <vector<double>> "Position of the center of the cylinder magnet in the global coordinate system (X,Y,Z)"
//       dynamic_viscosity_fluid <double> "Dynamic viscosity of the fluid"
//       rotation_around_x_axis <double> (default: 0) "Rotation of the magnet around the x-axis in degrees"
//       rotation_around_y_axis <double> (default: 0) "Rotation of the magnet around the y-axis in degrees"
//       particle_radius <double> "Radius of the magnetic particle"
//     particle_magnetization_model//       type <ParticleMagnetizationModelType>
//       <choices>

//       if value of type is linear//         susceptibility <double> "Magnetic susceptibility"

//       if value of type is linear_with_saturation//         <all_of>:
//           saturation_magnetization <double> "Saturation magnetization"
//           susceptibility <double> "Magnetic susceptibility"

//       if value of type is superparamagnetic//         saturation_magnetization <double> "Saturation magnetization"