From 9c3d1c1e177e892b45c2fccd2a311e1dfe7651dc Mon Sep 17 00:00:00 2001 From: katyhuff Date: Wed, 5 Jun 2024 01:40:45 +0000 Subject: [PATCH] Merge pull request #270 from nglaser3/add_doc Add diffusion theory and associated kernels to Theory page on Moltres website cde2f6a5d57601c47cc5a011157c355d64702010 --- citing.html | 2 +- development/contributing.html | 14 +- doxygen/_average_fission_heat_8_c.html | 2 +- doxygen/_average_fission_heat_8h.html | 2 +- doxygen/_average_fission_heat_8h_source.html | 2 +- doxygen/_cammi_fuel_8_c.html | 2 +- doxygen/_cammi_fuel_8h.html | 2 +- doxygen/_cammi_fuel_8h_source.html | 2 +- doxygen/_cammi_moderator_8_c.html | 2 +- doxygen/_cammi_moderator_8h.html | 2 +- doxygen/_cammi_moderator_8h_source.html | 2 +- ...conservative_advection_no_b_c_b_c_8_c.html | 2 +- ..._conservative_advection_no_b_c_b_c_8h.html | 2 +- ...vative_advection_no_b_c_b_c_8h_source.html | 2 +- doxygen/_constant_difference_aux_8_c.html | 2 +- doxygen/_constant_difference_aux_8h.html | 2 +- .../_constant_difference_aux_8h_source.html | 2 +- doxygen/_convective_heat_exchanger_8_c.html | 2 +- doxygen/_convective_heat_exchanger_8h.html | 2 +- .../_convective_heat_exchanger_8h_source.html | 2 +- doxygen/_coupled_fission_kernel_8_c.html | 2 +- doxygen/_coupled_fission_kernel_8h.html | 2 +- .../_coupled_fission_kernel_8h_source.html | 2 +- doxygen/_coupled_outflow_b_c_8_c.html | 2 +- doxygen/_coupled_outflow_b_c_8h.html | 2 +- doxygen/_coupled_outflow_b_c_8h_source.html | 2 +- doxygen/_coupled_scalar_advection_8_c.html | 2 +- doxygen/_coupled_scalar_advection_8h.html | 2 +- .../_coupled_scalar_advection_8h_source.html | 2 +- ...upled_scalar_advection_no_b_c_b_c_8_c.html | 2 +- ...oupled_scalar_advection_no_b_c_b_c_8h.html | 2 +- ...scalar_advection_no_b_c_b_c_8h_source.html | 2 +- doxygen/_d_g_turbulent_diffusion_8_c.html | 2 +- doxygen/_d_g_turbulent_diffusion_8h.html | 2 +- .../_d_g_turbulent_diffusion_8h_source.html | 2 +- doxygen/_decay_heat_source_8_c.html | 2 +- doxygen/_decay_heat_source_8h.html | 2 +- doxygen/_decay_heat_source_8h_source.html | 2 +- doxygen/_delayed_neutron_source_8_c.html | 2 +- doxygen/_delayed_neutron_source_8h.html | 2 +- .../_delayed_neutron_source_8h_source.html | 2 +- doxygen/_diffusion_no_b_c_b_c_8_c.html | 2 +- doxygen/_diffusion_no_b_c_b_c_8h.html | 2 +- doxygen/_diffusion_no_b_c_b_c_8h_source.html | 2 +- doxygen/_dirac_h_x_8_c.html | 2 +- doxygen/_dirac_h_x_8h.html | 2 +- doxygen/_dirac_h_x_8h_source.html | 2 +- ...div_free_coupled_scalar_advection_8_c.html | 2 +- ..._div_free_coupled_scalar_advection_8h.html | 2 +- ...ee_coupled_scalar_advection_8h_source.html | 2 +- doxygen/_division_postprocessor_8_c.html | 2 +- doxygen/_division_postprocessor_8h.html | 2 +- .../_division_postprocessor_8h_source.html | 2 +- doxygen/_element_l2_diff_8_c.html | 2 +- doxygen/_element_l2_diff_8h.html | 2 +- doxygen/_element_l2_diff_8h_source.html | 2 +- ...integ_tot_fiss_heat_postprocessor_8_c.html | 2 +- ..._integ_tot_fiss_heat_postprocessor_8h.html | 2 +- ...tot_fiss_heat_postprocessor_8h_source.html | 2 +- ..._integ_tot_fiss_nts_postprocessor_8_c.html | 2 +- ...m_integ_tot_fiss_nts_postprocessor_8h.html | 2 +- ..._tot_fiss_nts_postprocessor_8h_source.html | 2 +- ..._elm_integ_tot_fiss_postprocessor_8_c.html | 2 +- .../_elm_integ_tot_fiss_postprocessor_8h.html | 2 +- ...nteg_tot_fiss_postprocessor_8h_source.html | 2 +- doxygen/_fission_heat_source_8_c.html | 2 +- doxygen/_fission_heat_source_8h.html | 2 +- doxygen/_fission_heat_source_8h_source.html | 2 +- doxygen/_fission_heat_source_aux_8_c.html | 2 +- doxygen/_fission_heat_source_aux_8h.html | 2 +- .../_fission_heat_source_aux_8h_source.html | 2 +- ...fission_heat_source_transient_aux_8_c.html | 2 +- ..._fission_heat_source_transient_aux_8h.html | 2 +- ...n_heat_source_transient_aux_8h_source.html | 2 +- doxygen/_gamma_heat_source_8_c.html | 2 +- doxygen/_gamma_heat_source_8h.html | 2 +- doxygen/_gamma_heat_source_8h_source.html | 2 +- doxygen/_generic_moltres_material_8_c.html | 2 +- doxygen/_generic_moltres_material_8h.html | 2 +- .../_generic_moltres_material_8h_source.html | 2 +- ...ite_two_grp_x_s_function_material_8_c.html | 2 +- ...hite_two_grp_x_s_function_material_8h.html | 2 +- ...o_grp_x_s_function_material_8h_source.html | 2 +- doxygen/_group_diffusion_8_c.html | 2 +- doxygen/_group_diffusion_8h.html | 2 +- doxygen/_group_diffusion_8h_source.html | 2 +- doxygen/_heat_precursor_decay_8_c.html | 2 +- doxygen/_heat_precursor_decay_8h.html | 2 +- doxygen/_heat_precursor_decay_8h_source.html | 2 +- doxygen/_heat_precursor_source_8_c.html | 2 +- doxygen/_heat_precursor_source_8h.html | 2 +- doxygen/_heat_precursor_source_8h_source.html | 2 +- ..._s_a_d_energy_turbulent_diffusion_8_c.html | 2 +- ...n_s_a_d_energy_turbulent_diffusion_8h.html | 2 +- ..._energy_turbulent_diffusion_8h_source.html | 2 +- doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8_c.html | 2 +- doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h.html | 2 +- ..._i_n_s_a_d_mass_p_s_p_g_b_c_8h_source.html | 2 +- .../_i_n_s_a_d_momentum_s_u_p_g_b_c_8_c.html | 2 +- .../_i_n_s_a_d_momentum_s_u_p_g_b_c_8h.html | 2 +- ..._s_a_d_momentum_s_u_p_g_b_c_8h_source.html | 2 +- ...a_d_momentum_turbulent_no_b_c_b_c_8_c.html | 2 +- ..._a_d_momentum_turbulent_no_b_c_b_c_8h.html | 2 +- ...mentum_turbulent_no_b_c_b_c_8h_source.html | 2 +- ..._s_a_d_momentum_turbulent_viscous_8_c.html | 2 +- ...n_s_a_d_momentum_turbulent_viscous_8h.html | 2 +- ..._momentum_turbulent_viscous_8h_source.html | 2 +- doxygen/_i_n_s_boussinesq_body_force_8_c.html | 2 +- doxygen/_i_n_s_boussinesq_body_force_8h.html | 2 +- ...i_n_s_boussinesq_body_force_8h_source.html | 2 +- doxygen/_in_scatter_8_c.html | 2 +- doxygen/_in_scatter_8h.html | 2 +- doxygen/_in_scatter_8h_source.html | 2 +- ...tegral_new_variable_postprocessor_8_c.html | 2 +- ...ntegral_new_variable_postprocessor_8h.html | 2 +- ..._new_variable_postprocessor_8h_source.html | 2 +- ...tegral_old_variable_postprocessor_8_c.html | 2 +- ...ntegral_old_variable_postprocessor_8h.html | 2 +- ..._old_variable_postprocessor_8h_source.html | 2 +- doxygen/_limit_k_8_c.html | 2 +- doxygen/_limit_k_8h.html | 2 +- doxygen/_limit_k_8h_source.html | 2 +- .../_lin_log_penalty_dirichlet_b_c_8_c.html | 2 +- .../_lin_log_penalty_dirichlet_b_c_8h.html | 2 +- ...n_log_penalty_dirichlet_b_c_8h_source.html | 2 +- doxygen/_mat_diffusion_aux_8_c.html | 2 +- doxygen/_mat_diffusion_aux_8h.html | 2 +- doxygen/_mat_diffusion_aux_8h_source.html | 2 +- doxygen/_mat_diffusion_flux_b_c_8_c.html | 2 +- doxygen/_mat_diffusion_flux_b_c_8h.html | 2 +- .../_mat_diffusion_flux_b_c_8h_source.html | 2 +- ...derator_heat_source_transient_aux_8_c.html | 2 +- ...oderator_heat_source_transient_aux_8h.html | 2 +- ...r_heat_source_transient_aux_8h_source.html | 2 +- doxygen/_moltres_app_8_c.html | 2 +- doxygen/_moltres_app_8h.html | 2 +- doxygen/_moltres_app_8h_source.html | 2 +- doxygen/_moltres_json_material_8_c.html | 2 +- doxygen/_moltres_json_material_8h.html | 2 +- doxygen/_moltres_json_material_8h_source.html | 2 +- ...uel_two_grp_x_s_function_material_8_c.html | 2 +- ...fuel_two_grp_x_s_function_material_8h.html | 2 +- ...o_grp_x_s_function_material_8h_source.html | 2 +- doxygen/_neutron_leakage_8_c.html | 2 +- doxygen/_neutron_leakage_8h.html | 2 +- doxygen/_neutron_leakage_8h_source.html | 2 +- doxygen/_nt_action_8_c.html | 2 +- doxygen/_nt_action_8h.html | 2 +- doxygen/_nt_action_8h_source.html | 2 +- doxygen/_nt_time_derivative_8_c.html | 2 +- doxygen/_nt_time_derivative_8h.html | 2 +- doxygen/_nt_time_derivative_8h_source.html | 2 +- doxygen/_nuclear_material_8_c.html | 2 +- doxygen/_nuclear_material_8h.html | 2 +- doxygen/_nuclear_material_8h_source.html | 2 +- doxygen/_nusselt_8_c.html | 2 +- doxygen/_nusselt_8h.html | 2 +- doxygen/_nusselt_8h_source.html | 2 +- ..._postprocessor_coupled_inflow_b_c_8_c.html | 2 +- .../_postprocessor_coupled_inflow_b_c_8h.html | 2 +- ...rocessor_coupled_inflow_b_c_8h_source.html | 2 +- doxygen/_precursor_action_8_c.html | 2 +- doxygen/_precursor_action_8h.html | 2 +- doxygen/_precursor_action_8h_source.html | 2 +- doxygen/_precursor_decay_8_c.html | 2 +- doxygen/_precursor_decay_8h.html | 2 +- doxygen/_precursor_decay_8h_source.html | 2 +- doxygen/_precursor_source_8_c.html | 2 +- doxygen/_precursor_source_8h.html | 2 +- doxygen/_precursor_source_8h_source.html | 2 +- doxygen/_rodded_material_8_c.html | 2 +- doxygen/_rodded_material_8h.html | 2 +- doxygen/_rodded_material_8h_source.html | 2 +- doxygen/_s_a_tau_material_8_c.html | 2 +- doxygen/_s_a_tau_material_8h.html | 2 +- doxygen/_s_a_tau_material_8h_source.html | 2 +- doxygen/_s_a_tau_stabilized3_eqn_8_c.html | 2 +- doxygen/_s_a_tau_stabilized3_eqn_8h.html | 2 +- .../_s_a_tau_stabilized3_eqn_8h_source.html | 2 +- doxygen/_s_a_time_derivative_8_c.html | 2 +- doxygen/_s_a_time_derivative_8h.html | 2 +- doxygen/_s_a_time_derivative_8h_source.html | 2 +- doxygen/_s_a_turbulent_viscosity_8_c.html | 2 +- doxygen/_s_a_turbulent_viscosity_8h.html | 2 +- .../_s_a_turbulent_viscosity_8h_source.html | 2 +- doxygen/_s_a_turbulent_viscosity_aux_8_c.html | 2 +- doxygen/_s_a_turbulent_viscosity_aux_8h.html | 2 +- ...s_a_turbulent_viscosity_aux_8h_source.html | 2 +- ..._a_turbulent_viscosity_no_b_c_b_c_8_c.html | 2 +- ...s_a_turbulent_viscosity_no_b_c_b_c_8h.html | 2 +- ...bulent_viscosity_no_b_c_b_c_8h_source.html | 2 +- .../_s_a_turbulent_viscosity_s_u_p_g_8_c.html | 2 +- .../_s_a_turbulent_viscosity_s_u_p_g_8h.html | 2 +- ...turbulent_viscosity_s_u_p_g_8h_source.html | 2 +- ...a_turbulent_viscosity_s_u_p_g_b_c_8_c.html | 2 +- ..._a_turbulent_viscosity_s_u_p_g_b_c_8h.html | 2 +- ...ulent_viscosity_s_u_p_g_b_c_8h_source.html | 2 +- doxygen/_scalar_advection_art_diff_8_c.html | 2 +- doxygen/_scalar_advection_art_diff_8h.html | 2 +- .../_scalar_advection_art_diff_8h_source.html | 2 +- ...lar_advection_art_diff_no_b_c_b_c_8_c.html | 2 +- ...alar_advection_art_diff_no_b_c_b_c_8h.html | 2 +- ...vection_art_diff_no_b_c_b_c_8h_source.html | 2 +- doxygen/_scalar_transport_base_8_c.html | 2 +- doxygen/_scalar_transport_base_8h.html | 2 +- doxygen/_scalar_transport_base_8h_source.html | 2 +- ..._scalar_transport_time_derivative_8_c.html | 2 +- .../_scalar_transport_time_derivative_8h.html | 2 +- ...r_transport_time_derivative_8h_source.html | 2 +- ...e_weighted_integral_postprocessor_8_c.html | 2 +- ...de_weighted_integral_postprocessor_8h.html | 2 +- ...hted_integral_postprocessor_8h_source.html | 2 +- doxygen/_sigma_r_8_c.html | 2 +- doxygen/_sigma_r_8h.html | 2 +- doxygen/_sigma_r_8h_source.html | 2 +- doxygen/_total_neutron_leakage_8_c.html | 2 +- doxygen/_total_neutron_leakage_8h.html | 2 +- doxygen/_total_neutron_leakage_8h_source.html | 2 +- .../_transient_fission_heat_source_8_c.html | 2 +- .../_transient_fission_heat_source_8h.html | 2 +- ...ansient_fission_heat_source_8h_source.html | 2 +- doxygen/_turbulent_stress_aux_8_c.html | 2 +- doxygen/_turbulent_stress_aux_8h.html | 2 +- doxygen/_turbulent_stress_aux_8h_source.html | 2 +- doxygen/_vacuum_conc_b_c_8_c.html | 2 +- doxygen/_vacuum_conc_b_c_8h.html | 2 +- doxygen/_vacuum_conc_b_c_8h_source.html | 2 +- ...ariable_not_a_moose_object_action_8_c.html | 2 +- ...variable_not_a_moose_object_action_8h.html | 2 +- ...e_not_a_moose_object_action_8h_source.html | 2 +- doxygen/_wall_distance_aux_8_c.html | 2 +- doxygen/_wall_distance_aux_8h.html | 2 +- doxygen/_wall_distance_aux_8h_source.html | 2 +- doxygen/_wall_shear_stress_aux_8_c.html | 2 +- doxygen/_wall_shear_stress_aux_8h.html | 2 +- doxygen/_wall_shear_stress_aux_8h_source.html | 2 +- doxygen/annotated.html | 2 +- .../class_average_fission_heat-members.html | 2 +- doxygen/class_average_fission_heat.html | 2 +- doxygen/class_cammi_fuel-members.html | 2 +- doxygen/class_cammi_fuel.html | 2 +- doxygen/class_cammi_moderator-members.html | 2 +- doxygen/class_cammi_moderator.html | 2 +- ...ervative_advection_no_b_c_b_c-members.html | 2 +- ...ass_conservative_advection_no_b_c_b_c.html | 2 +- ...class_constant_difference_aux-members.html | 2 +- doxygen/class_constant_difference_aux.html | 2 +- ...ass_convective_heat_exchanger-members.html | 2 +- doxygen/class_convective_heat_exchanger.html | 2 +- .../class_coupled_fission_kernel-members.html | 2 +- doxygen/class_coupled_fission_kernel.html | 2 +- .../class_coupled_outflow_b_c-members.html | 2 +- doxygen/class_coupled_outflow_b_c.html | 2 +- ...lass_coupled_scalar_advection-members.html | 2 +- doxygen/class_coupled_scalar_advection.html | 2 +- ...d_scalar_advection_no_b_c_b_c-members.html | 2 +- ...s_coupled_scalar_advection_no_b_c_b_c.html | 2 +- ...class_d_g_turbulent_diffusion-members.html | 2 +- doxygen/class_d_g_turbulent_diffusion.html | 2 +- doxygen/class_decay_heat_source-members.html | 2 +- doxygen/class_decay_heat_source.html | 2 +- .../class_delayed_neutron_source-members.html | 2 +- doxygen/class_delayed_neutron_source.html | 2 +- .../class_diffusion_no_b_c_b_c-members.html | 2 +- doxygen/class_diffusion_no_b_c_b_c.html | 2 +- doxygen/class_dirac_h_x-members.html | 2 +- doxygen/class_dirac_h_x.html | 2 +- ...free_coupled_scalar_advection-members.html | 2 +- ...ass_div_free_coupled_scalar_advection.html | 2 +- .../class_division_postprocessor-members.html | 2 +- doxygen/class_division_postprocessor.html | 2 +- doxygen/class_element_l2_diff-members.html | 2 +- doxygen/class_element_l2_diff.html | 2 +- ...g_tot_fiss_heat_postprocessor-members.html | 2 +- ...elm_integ_tot_fiss_heat_postprocessor.html | 2 +- ...eg_tot_fiss_nts_postprocessor-members.html | 2 +- ..._elm_integ_tot_fiss_nts_postprocessor.html | 2 +- ..._integ_tot_fiss_postprocessor-members.html | 2 +- ...lass_elm_integ_tot_fiss_postprocessor.html | 2 +- .../class_fission_heat_source-members.html | 2 +- doxygen/class_fission_heat_source.html | 2 +- ...class_fission_heat_source_aux-members.html | 2 +- doxygen/class_fission_heat_source_aux.html | 2 +- ...ion_heat_source_transient_aux-members.html | 2 +- ...ass_fission_heat_source_transient_aux.html | 2 +- doxygen/class_gamma_heat_source-members.html | 2 +- doxygen/class_gamma_heat_source.html | 2 +- ...lass_generic_moltres_material-members.html | 2 +- doxygen/class_generic_moltres_material.html | 2 +- ...two_grp_x_s_function_material-members.html | 2 +- ...raphite_two_grp_x_s_function_material.html | 2 +- doxygen/class_group_diffusion-members.html | 2 +- doxygen/class_group_diffusion.html | 2 +- .../class_heat_precursor_decay-members.html | 2 +- doxygen/class_heat_precursor_decay.html | 2 +- .../class_heat_precursor_source-members.html | 2 +- doxygen/class_heat_precursor_source.html | 2 +- ..._d_energy_turbulent_diffusion-members.html | 2 +- ..._i_n_s_a_d_energy_turbulent_diffusion.html | 2 +- ...ss_i_n_s_a_d_mass_p_s_p_g_b_c-members.html | 2 +- doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c.html | 2 +- ..._n_s_a_d_momentum_s_u_p_g_b_c-members.html | 2 +- .../class_i_n_s_a_d_momentum_s_u_p_g_b_c.html | 2 +- ...momentum_turbulent_no_b_c_b_c-members.html | 2 +- ...n_s_a_d_momentum_turbulent_no_b_c_b_c.html | 2 +- ..._d_momentum_turbulent_viscous-members.html | 2 +- ..._i_n_s_a_d_momentum_turbulent_viscous.html | 2 +- ...s_i_n_s_boussinesq_body_force-members.html | 2 +- .../class_i_n_s_boussinesq_body_force.html | 2 +- doxygen/class_in_scatter-members.html | 2 +- doxygen/class_in_scatter.html | 2 +- ...al_new_variable_postprocessor-members.html | 2 +- ...s_integral_new_variable_postprocessor.html | 2 +- ...al_old_variable_postprocessor-members.html | 2 +- ...s_integral_old_variable_postprocessor.html | 2 +- doxygen/class_limit_k-members.html | 2 +- doxygen/class_limit_k.html | 2 +- ...lin_log_penalty_dirichlet_b_c-members.html | 2 +- .../class_lin_log_penalty_dirichlet_b_c.html | 2 +- doxygen/class_mat_diffusion_aux-members.html | 2 +- doxygen/class_mat_diffusion_aux.html | 2 +- .../class_mat_diffusion_flux_b_c-members.html | 2 +- doxygen/class_mat_diffusion_flux_b_c.html | 2 +- ...tor_heat_source_transient_aux-members.html | 2 +- ...s_moderator_heat_source_transient_aux.html | 2 +- doxygen/class_moltres_app-members.html | 2 +- doxygen/class_moltres_app.html | 2 +- .../class_moltres_json_material-members.html | 2 +- doxygen/class_moltres_json_material.html | 2 +- ...two_grp_x_s_function_material-members.html | 2 +- ...re_fuel_two_grp_x_s_function_material.html | 2 +- doxygen/class_neutron_leakage-members.html | 2 +- doxygen/class_neutron_leakage.html | 2 +- doxygen/class_nt_action-members.html | 2 +- doxygen/class_nt_action.html | 2 +- doxygen/class_nt_time_derivative-members.html | 2 +- doxygen/class_nt_time_derivative.html | 2 +- doxygen/class_nuclear_material-members.html | 2 +- doxygen/class_nuclear_material.html | 2 +- doxygen/class_nusselt-members.html | 2 +- doxygen/class_nusselt.html | 2 +- ...tprocessor_coupled_inflow_b_c-members.html | 2 +- ...lass_postprocessor_coupled_inflow_b_c.html | 2 +- doxygen/class_precursor_action-members.html | 2 +- doxygen/class_precursor_action.html | 2 +- doxygen/class_precursor_decay-members.html | 2 +- doxygen/class_precursor_decay.html | 2 +- doxygen/class_precursor_source-members.html | 2 +- doxygen/class_precursor_source.html | 2 +- doxygen/class_rodded_material-members.html | 2 +- doxygen/class_rodded_material.html | 2 +- .../class_s_a_tau_material_templ-members.html | 2 +- doxygen/class_s_a_tau_material_templ.html | 2 +- ...class_s_a_tau_stabilized3_eqn-members.html | 2 +- doxygen/class_s_a_tau_stabilized3_eqn.html | 2 +- .../class_s_a_time_derivative-members.html | 2 +- doxygen/class_s_a_time_derivative.html | 2 +- ...class_s_a_turbulent_viscosity-members.html | 2 +- doxygen/class_s_a_turbulent_viscosity.html | 2 +- ...s_s_a_turbulent_viscosity_aux-members.html | 2 +- .../class_s_a_turbulent_viscosity_aux.html | 2 +- ...urbulent_viscosity_no_b_c_b_c-members.html | 2 +- ...ss_s_a_turbulent_viscosity_no_b_c_b_c.html | 2 +- ...a_turbulent_viscosity_s_u_p_g-members.html | 2 +- ...class_s_a_turbulent_viscosity_s_u_p_g.html | 2 +- ...rbulent_viscosity_s_u_p_g_b_c-members.html | 2 +- ...s_s_a_turbulent_viscosity_s_u_p_g_b_c.html | 2 +- ...ass_scalar_advection_art_diff-members.html | 2 +- doxygen/class_scalar_advection_art_diff.html | 2 +- ...advection_art_diff_no_b_c_b_c-members.html | 2 +- ..._scalar_advection_art_diff_no_b_c_b_c.html | 2 +- .../class_scalar_transport_base-members.html | 2 +- doxygen/class_scalar_transport_base.html | 2 +- ...lar_transport_time_derivative-members.html | 2 +- ...lass_scalar_transport_time_derivative.html | 2 +- ...ighted_integral_postprocessor-members.html | 2 +- ..._side_weighted_integral_postprocessor.html | 2 +- doxygen/class_sigma_r-members.html | 2 +- doxygen/class_sigma_r.html | 2 +- .../class_total_neutron_leakage-members.html | 2 +- doxygen/class_total_neutron_leakage.html | 2 +- ...transient_fission_heat_source-members.html | 2 +- .../class_transient_fission_heat_source.html | 2 +- .../class_turbulent_stress_aux-members.html | 2 +- doxygen/class_turbulent_stress_aux.html | 2 +- doxygen/class_vacuum_conc_b_c-members.html | 2 +- doxygen/class_vacuum_conc_b_c.html | 2 +- ...ble_not_a_moose_object_action-members.html | 2 +- ...ss_variable_not_a_moose_object_action.html | 2 +- doxygen/class_wall_distance_aux-members.html | 2 +- doxygen/class_wall_distance_aux.html | 2 +- .../class_wall_shear_stress_aux-members.html | 2 +- doxygen/class_wall_shear_stress_aux.html | 2 +- doxygen/classes.html | 2 +- doxygen/dir_000001_000012.html | 2 +- doxygen/dir_000003_000012.html | 2 +- doxygen/dir_000005_000012.html | 2 +- doxygen/dir_000006_000004.html | 2 +- doxygen/dir_000007_000012.html | 2 +- doxygen/dir_000009_000012.html | 2 +- doxygen/dir_000011_000012.html | 2 +- doxygen/dir_000013_000004.html | 2 +- doxygen/dir_000014_000012.html | 2 +- doxygen/dir_000016_000012.html | 2 +- doxygen/dir_000017_000004.html | 2 +- doxygen/dir_000018_000012.html | 2 +- doxygen/dir_000019_000012.html | 2 +- .../dir_0af1587c8378955de40f48b4bd1869f0.html | 2 +- .../dir_0b9ed7732631b4e65a5030233eb5fc5a.html | 2 +- .../dir_40856f0cdd4bcafd28810d9265a200f7.html | 2 +- .../dir_52afe6394927cedcb1ddeb1178eb9949.html | 2 +- .../dir_5cafbbc4d3ca7520a589c9bb006faf2e.html | 2 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- .../dir_6c5a344b9c03c6428d49f0b38500fe7f.html | 2 +- .../dir_6c6f4828ced252df7a457d18180150c1.html | 2 +- .../dir_79fa9b12a48436e6d1fb80a586e19af1.html | 2 +- .../dir_88ecfc89524da6b1e182c4fbbebb4797.html | 2 +- .../dir_a0ffb46312fd942a3bdda3379138cd3d.html | 2 +- .../dir_ab1c81409f0df724f17c9ef30afee877.html | 2 +- .../dir_ad471e77ba5a72af0767bcb44d2be997.html | 2 +- .../dir_b42fa4734c76de29a4b97f55d0ce97b5.html | 2 +- .../dir_b843596cc84dd0b637fa3210ef36d913.html | 2 +- .../dir_d2b8d8eda696fb67dda800ae051affdc.html | 2 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- .../dir_e313ae6235229141100fd0edcf178102.html | 2 +- .../dir_e8162cbcd2a0630786d64b00f43c2c71.html | 2 +- .../dir_f2fd8bd6424c93166d6dd5f2b70706e7.html | 2 +- doxygen/files.html | 2 +- doxygen/functions.html | 2 +- doxygen/functions_a.html | 2 +- doxygen/functions_b.html | 2 +- doxygen/functions_c.html | 2 +- doxygen/functions_d.html | 2 +- doxygen/functions_e.html | 2 +- doxygen/functions_enum.html | 2 +- doxygen/functions_eval.html | 2 +- doxygen/functions_f.html | 2 +- doxygen/functions_func.html | 2 +- doxygen/functions_func_b.html | 2 +- doxygen/functions_func_c.html | 2 +- doxygen/functions_func_d.html | 2 +- doxygen/functions_func_e.html | 2 +- doxygen/functions_func_f.html | 2 +- doxygen/functions_func_g.html | 2 +- doxygen/functions_func_h.html | 2 +- doxygen/functions_func_i.html | 2 +- doxygen/functions_func_l.html | 2 +- doxygen/functions_func_m.html | 2 +- doxygen/functions_func_n.html | 2 +- doxygen/functions_func_p.html | 2 +- doxygen/functions_func_q.html | 2 +- doxygen/functions_func_r.html | 2 +- doxygen/functions_func_s.html | 2 +- doxygen/functions_func_t.html | 2 +- doxygen/functions_func_v.html | 2 +- doxygen/functions_func_w.html | 2 +- doxygen/functions_func_~.html | 2 +- doxygen/functions_g.html | 2 +- doxygen/functions_h.html | 2 +- doxygen/functions_i.html | 2 +- doxygen/functions_l.html | 2 +- doxygen/functions_m.html | 2 +- doxygen/functions_n.html | 2 +- doxygen/functions_p.html | 2 +- doxygen/functions_q.html | 2 +- doxygen/functions_r.html | 2 +- doxygen/functions_s.html | 2 +- doxygen/functions_t.html | 2 +- doxygen/functions_v.html | 2 +- doxygen/functions_vars.html | 2 +- doxygen/functions_w.html | 2 +- doxygen/functions_~.html | 2 +- doxygen/globals.html | 2 +- doxygen/globals_func.html | 2 +- doxygen/globals_type.html | 2 +- doxygen/graph_legend.html | 2 +- doxygen/hierarchy.html | 2 +- doxygen/index.html | 2 +- doxygen/inherits.html | 2 +- doxygen/main_8_c.html | 2 +- getting_started/eigenvalue.html | 2 +- getting_started/input_syntax.html | 30 +- getting_started/installation.html | 8 +- getting_started/moltres_xs.html | 6 +- getting_started/recommended.html | 10 +- getting_started/sss2_gc.html | 4 +- getting_started/theory.html | 14 +- getting_started/transient.html | 2 +- getting_started/tutorials.html | 2 +- help.html | 2 +- index.html | 2 +- publications.html | 28 +- source/actions/NtAction.html | 2 +- source/actions/PrecursorAction.html | 2 +- source/auxkernels/ConstantDifferenceAux.html | 238 +- source/auxkernels/Density.html | 2 +- source/auxkernels/FissionHeatSourceAux.html | 3060 +- .../FissionHeatSourceTransientAux.html | 4432 +- source/auxkernels/FunctionDerivativeAux.html | 2 +- source/auxkernels/MatDiffusionAux.html | 878 +- .../ModeratorHeatSourceTransientAux.html | 3480 +- .../auxkernels/SATurbulentViscosityAux.html | 662 +- source/auxkernels/TurbulentStressAux.html | 662 +- source/auxkernels/WallDistanceAux.html | 662 +- source/auxkernels/WallShearStressAux.html | 662 +- source/bcs/ChannelGradientBC.html | 2 +- source/bcs/ConservativeAdvectionNoBCBC.html | 4 +- source/bcs/CoupledOutflowBC.html | 4 +- source/bcs/CoupledScalarAdvectionNoBCBC.html | 4 +- .../DGDiffusionPostprocessorDirichletBC.html | 2 +- source/bcs/DiffusionNoBCBC.html | 4 +- source/bcs/DiffusiveFluxBC.html | 2 +- source/bcs/ExampleShapeSideIntegratedBC.html | 2 +- .../bcs/FlexiblePostprocessorDirichletBC.html | 2 +- source/bcs/INSADMassPSPGBC.html | 662 +- source/bcs/INSADMomentumSUPGBC.html | 662 +- source/bcs/INSADMomentumTurbulentNoBCBC.html | 662 +- source/bcs/InflowBC.html | 2 +- source/bcs/LinLogPenaltyDirichletBC.html | 6 +- source/bcs/MatDiffusionFluxBC.html | 2 +- source/bcs/MatINSTemperatureNoBCBC.html | 2 +- source/bcs/OutflowBC.html | 2 +- source/bcs/PostprocessorCoupledInflowBC.html | 4 +- source/bcs/PostprocessorInflowBC.html | 2 +- .../bcs/PostprocessorTemperatureInflowBC.html | 2 +- source/bcs/RobinBC.html | 2 +- source/bcs/SATurbulentViscosityNoBCBC.html | 662 +- source/bcs/SATurbulentViscositySUPGBC.html | 662 +- source/bcs/ScalarAdvectionArtDiffNoBCBC.html | 488 +- source/bcs/TemperatureInflowBC.html | 2 +- source/bcs/TemperatureOutflowBC.html | 2 +- source/bcs/VacuumConcBC.html | 17988 ++++---- source/bcs/VelocityFunctionOutflowBC.html | 2 +- .../VelocityFunctionTemperatureOutflowBC.html | 2 +- source/dgkernels/DGCoupledAdvection.html | 2 +- source/dgkernels/DGFunctionConvection.html | 2 +- .../DGFunctionTemperatureAdvection.html | 2 +- source/dgkernels/DGTemperatureAdvection.html | 2 +- source/dgkernels/DGTurbulentDiffusion.html | 6 +- source/dirackernels/DiracHX.html | 466 +- .../InterTemperatureAdvection.html | 2 +- .../ConservativeTemperatureAdvection.html | 2 +- source/kernels/ConvectiveHeatExchanger.html | 88 +- source/kernels/CoupledFissionKernel.html | 15944 +++---- source/kernels/CoupledScalarAdvection.html | 4 +- source/kernels/CtrlConservativeAdvection.html | 2 +- .../CtrlConservativeTemperatureAdvection.html | 2 +- source/kernels/DecayHeatSource.html | 2 +- source/kernels/DelayedNeutronSource.html | 11624 ++--- .../DivFreeCoupledScalarAdvection.html | 2 +- source/kernels/FissionHeatSource.html | 1548 +- source/kernels/GammaHeatSource.html | 16712 +++---- source/kernels/GroupDiffusion.html | 23748 +++++----- source/kernels/HeatPrecursorDecay.html | 4 +- source/kernels/HeatPrecursorSource.html | 4 +- .../INSADEnergyTurbulentDiffusion.html | 6 +- .../INSADMomentumTurbulentViscous.html | 662 +- source/kernels/INSBoussinesqBodyForce.html | 624 +- source/kernels/InScatter.html | 24118 +++++------ .../MatINSTemperatureTimeDerivative.html | 2 +- source/kernels/NonConservativeAdvection.html | 2 +- source/kernels/NtTimeDerivative.html | 15878 +++---- source/kernels/PotentialAdvection.html | 2 +- source/kernels/PrecursorDecay.html | 4 +- source/kernels/PrecursorSource.html | 4 +- source/kernels/SATimeDerivative.html | 662 +- source/kernels/SATurbulentViscosity.html | 662 +- source/kernels/ScalarAdvectionArtDiff.html | 1032 +- .../ScalarTransportTimeDerivative.html | 6 +- source/kernels/SigmaR.html | 25342 +++++------ .../kernels/TransientFissionHeatSource.html | 21848 +++++----- .../VelocityFunctionTemperatureAdvection.html | 2 +- source/materials/CammiFuel.html | 2468 +- source/materials/CammiModerator.html | 2468 +- source/materials/GenericMoltresMaterial.html | 35860 ++++++++-------- .../GraphiteTwoGrpXSFunctionMaterial.html | 2386 +- source/materials/MoltresJsonMaterial.html | 1340 +- .../MsreFuelTwoGrpXSFunctionMaterial.html | 2386 +- source/materials/NuclearMaterial.html | 6 +- source/materials/Nusselt.html | 2 +- source/materials/RoddedMaterial.html | 478 +- source/materials/SATauMaterial.html | 838 +- source/materials/SATauStabilized3Eqn.html | 6 +- source/postprocessors/AverageFissionHeat.html | 13710 +++--- .../postprocessors/DivisionPostprocessor.html | 20998 ++++----- source/postprocessors/ElementL2Diff.html | 12710 +++--- .../ElmIntegTotFissHeatPostprocessor.html | 2202 +- .../ElmIntegTotFissNtsPostprocessor.html | 12240 +++--- .../ElmIntegTotFissPostprocessor.html | 10808 ++--- .../IntegralNewVariablePostprocessor.html | 20748 ++++----- .../IntegralOldVariablePostprocessor.html | 20998 ++++----- source/postprocessors/LimitK.html | 1568 +- .../SideWeightedIntegralPostprocessor.html | 6 +- .../userobjects/DenomShapeSideUserObject.html | 2 +- .../userobjects/NumShapeSideUserObject.html | 2 +- .../vectorpostprocessors/ChannelGradient.html | 2 +- syntax/Nt/index.html | 2 +- syntax/Precursors/index.html | 2 +- syntax/index.html | 2 +- 599 files changed, 181466 insertions(+), 181466 deletions(-) diff --git a/citing.html b/citing.html index b4f73ae7e..bdb23ce0d 100644 --- a/citing.html +++ b/citing.html @@ -1,4 +1,4 @@ -Citing Moltres | Moltres

Citing Moltres

You may cite Moltres through the following publication:


+Citing Moltres | Moltres
Citing Moltres
You may cite Moltres through the following publication:

 @article{lindsay_introduction_2018,
     title = {Introduction to {Moltres}: {An} application for simulation of {Molten} {Salt} {Reactors}},
     volume = {114},
diff --git a/development/contributing.html b/development/contributing.html
index 2a484f8a8..2fa0ce25c 100644
--- a/development/contributing.html
+++ b/development/contributing.html
@@ -1,11 +1,11 @@
-Contributing | Moltres
Contributing
The contributing guidelines here are mostly adapted from MOOSE contributing guidelines and Commit Often, Perfect Later, Publish Once: Git Best Practices by Seth Robertson (CC BY-SA 3.0).
Code Standards
Like MOOSE, Moltres uses the ClangFormat for formatting all C++ code in the repository. If you ever want to contribute changes to the Moltres repository, make you run the following command to automatically format any new code in your current branch relative to the supplied <branch> (defaults to HEAD if omitted).

+Contributing | Moltres
Contributing
The contributing guidelines here are mostly adapted from MOOSE contributing guidelines and Commit Often, Perfect Later, Publish Once: Git Best Practices by Seth Robertson (CC BY-SA 3.0).
Code Standards
Like MOOSE, Moltres uses the ClangFormat for formatting all C++ code in the repository. If you ever want to contribute changes to the Moltres repository, make you run the following command to automatically format any new code in your current branch relative to the supplied <branch> (defaults to HEAD if omitted).

 git clang-format [<branch>]
-
The configuration file for the formatting is provided in the .clang-format file in the base directory. Refer to MOOSE Code Standards for more details on the code standard.
Referencing Issues
In every pull request, we strongly recommend referencing an issue. This practice encourages robust discussions on whether the change is necessary and appropriate to Moltres. It also provides relevant context to the new changes proposed for quicker code review.
Work in a Fork
1. Fork Moltres
Create your own fork where you can make and commit your set of changes.
  • Navigate to https://github.com/arfc/moltres 
  • Click the "Fork" button near the upper right corner of the page. 
  • Clone your new fork to your local machine using the following command (replace "username" with your GitHub username):

+
The configuration file for the formatting is provided in the .clang-format file in the base directory. Refer to MOOSE Code Standards for more details on the code standard.
Referencing Issues
In every pull request, we strongly recommend referencing an issue. This practice encourages robust discussions on whether the change is necessary and appropriate to Moltres. It also provides relevant context to the new changes proposed for quicker code review.
Work in a Fork
1. Fork Moltres
Create your own fork where you can make and commit your set of changes.
  • Navigate to https://github.com/arfc/moltres 
  • Click the "Fork" button near the upper right corner of the page. 
  • Clone your new fork to your local machine using the following command (replace "username" with your GitHub username):

 git clone git@github.com:username/moltres.git
-
2. Add the upstream Remote
Add the original Moltres repository as a remote named upstream:

+
2. Add the upstream Remote
Add the original Moltres repository as a remote named upstream:

 cd moltres
 git remote add upstream git@github.com:arfc/moltres.git
-
3. Make Changes to Moltres
Create a branch for your work:

+
3. Make Changes to Moltres
Create a branch for your work:

 git checkout -b branch_name
 
Make your changes and commit them to the branch you just created:

 git add your_new_file.C your_new_file.h
@@ -16,10 +16,10 @@
 git merge upstream/devel
 git checkout branch_name
 git merge devel
-
schooltip
Refer to Commit Often, Perfect Later, Publish Once: Git Best Practices for an in-depth guide on Git workflows.
4. Update Documentation
If you make any changes to the source code which alters functionality, please make the corresponding changes to the documentation in moltres/doc/content/source for the specific class you modified. You may build this website locally to review your documentation changes by compiling Moltres without the optional MOOSE modules and running the MooseDocs python script as follows:

+
schooltip
Refer to Commit Often, Perfect Later, Publish Once: Git Best Practices for an in-depth guide on Git workflows.
4. Update Documentation
If you make any changes to the source code which alters functionality, please make the corresponding changes to the documentation in moltres/doc/content/source for the specific class you modified. You may build this website locally to review your documentation changes by compiling Moltres without the optional MOOSE modules and running the MooseDocs python script as follows:

 make NAVIER_STOKES:='no' PHASE_FIELD:='no' -j 4
 cd doc
 ./moosedocs.py build --serve
-
Remember to recompile Moltres using make -j 4 afterwards if you intend to run Moltres input files.
schooltip
Feel free to reach out to anyone in the Moltres development team for help with documentation.
commentnote
Detailed documentation of Moltres syntax is currently a work in progress. However, feel free to contribute if you are familiar with the source code.
5. Push Your Changes to Your GitHub Fork
Push your branch to your fork on GitHub.

+
Remember to recompile Moltres using make -j 4 afterwards if you intend to run Moltres input files.
schooltip
Feel free to reach out to anyone in the Moltres development team for help with documentation.
commentnote
Detailed documentation of Moltres syntax is currently a work in progress. However, feel free to contribute if you are familiar with the source code.
5. Push Your Changes to Your GitHub Fork
Push your branch to your fork on GitHub.

 git push origin branch_name
-
Create a Pull Request
Once you are satisfied with the changes you've made,  and you've checked that the tests pass and your documentation is clear,  go back to the main Moltres repository and create a pull request  to merge your branch to the Moltres devel branch. If you had just pushed your branch to GitHub, GitHub will display a prompt asking whether you wish to create a new pull request using that branch. Otherwise, simply select your fork and branch from the dropdown list in the new pull request page.
Review & Merge
Someone from the Moltres development team will review your pull request and either request additional changes or approve your pull request. 

\ No newline at end of file
+
Create a Pull Request
Once you are satisfied with the changes you've made,  and you've checked that the tests pass and your documentation is clear,  go back to the main Moltres repository and create a pull request  to merge your branch to the Moltres devel branch. If you had just pushed your branch to GitHub, GitHub will display a prompt asking whether you wish to create a new pull request using that branch. Otherwise, simply select your fork and branch from the dropdown list in the new pull request page.
Review & Merge
Someone from the Moltres development team will review your pull request and either request additional changes or approve your pull request. 

\ No newline at end of file
diff --git a/doxygen/_average_fission_heat_8_c.html b/doxygen/_average_fission_heat_8_c.html
index d9bc11e7a..c3881104e 100644
--- a/doxygen/_average_fission_heat_8_c.html
+++ b/doxygen/_average_fission_heat_8_c.html
@@ -129,7 +129,7 @@ 

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8
+Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
 

 
 
diff --git a/doxygen/_average_fission_heat_8h.html b/doxygen/_average_fission_heat_8h.html
index e7cc922bc..283c33d9c 100644
--- a/doxygen/_average_fission_heat_8h.html
+++ b/doxygen/_average_fission_heat_8h.html
@@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_average_fission_heat_8h_source.html b/doxygen/_average_fission_heat_8h_source.html index 628c98806..5397cb7a3 100644 --- a/doxygen/_average_fission_heat_8h_source.html +++ b/doxygen/_average_fission_heat_8h_source.html @@ -125,7 +125,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8_c.html b/doxygen/_cammi_fuel_8_c.html index 787f8fb7c..b1f0b9940 100644 --- a/doxygen/_cammi_fuel_8_c.html +++ b/doxygen/_cammi_fuel_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8h.html b/doxygen/_cammi_fuel_8h.html index 54929f368..d876fb369 100644 --- a/doxygen/_cammi_fuel_8h.html +++ b/doxygen/_cammi_fuel_8h.html @@ -109,7 +109,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8h_source.html b/doxygen/_cammi_fuel_8h_source.html index 5493ff793..0e57fa640 100644 --- a/doxygen/_cammi_fuel_8h_source.html +++ b/doxygen/_cammi_fuel_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8_c.html b/doxygen/_cammi_moderator_8_c.html index edc70be42..ceb073544 100644 --- a/doxygen/_cammi_moderator_8_c.html +++ b/doxygen/_cammi_moderator_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8h.html b/doxygen/_cammi_moderator_8h.html index e45d73842..4d0c96546 100644 --- a/doxygen/_cammi_moderator_8h.html +++ b/doxygen/_cammi_moderator_8h.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8h_source.html b/doxygen/_cammi_moderator_8h_source.html index 2221ea969..2de716d91 100644 --- a/doxygen/_cammi_moderator_8h_source.html +++ b/doxygen/_cammi_moderator_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_conservative_advection_no_b_c_b_c_8_c.html b/doxygen/_conservative_advection_no_b_c_b_c_8_c.html index 639b45fd3..9e018681d 100644 --- a/doxygen/_conservative_advection_no_b_c_b_c_8_c.html +++ b/doxygen/_conservative_advection_no_b_c_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_conservative_advection_no_b_c_b_c_8h.html b/doxygen/_conservative_advection_no_b_c_b_c_8h.html index 1b985356b..e4225ad7e 100644 --- a/doxygen/_conservative_advection_no_b_c_b_c_8h.html +++ b/doxygen/_conservative_advection_no_b_c_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_conservative_advection_no_b_c_b_c_8h_source.html b/doxygen/_conservative_advection_no_b_c_b_c_8h_source.html index ae3c14490..7745bb950 100644 --- a/doxygen/_conservative_advection_no_b_c_b_c_8h_source.html +++ b/doxygen/_conservative_advection_no_b_c_b_c_8h_source.html @@ -115,7 +115,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_constant_difference_aux_8_c.html b/doxygen/_constant_difference_aux_8_c.html index 20ea9ae28..4316dd1db 100644 --- a/doxygen/_constant_difference_aux_8_c.html +++ b/doxygen/_constant_difference_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_constant_difference_aux_8h.html b/doxygen/_constant_difference_aux_8h.html index a8ac59800..7794209c0 100644 --- a/doxygen/_constant_difference_aux_8h.html +++ b/doxygen/_constant_difference_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_constant_difference_aux_8h_source.html b/doxygen/_constant_difference_aux_8h_source.html index 05b1ba3f0..bfb75198f 100644 --- a/doxygen/_constant_difference_aux_8h_source.html +++ b/doxygen/_constant_difference_aux_8h_source.html @@ -115,7 +115,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_convective_heat_exchanger_8_c.html b/doxygen/_convective_heat_exchanger_8_c.html index a169391cb..429c45f42 100644 --- a/doxygen/_convective_heat_exchanger_8_c.html +++ b/doxygen/_convective_heat_exchanger_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_convective_heat_exchanger_8h.html b/doxygen/_convective_heat_exchanger_8h.html index 9ee4c61a7..fce4d6a01 100644 --- a/doxygen/_convective_heat_exchanger_8h.html +++ b/doxygen/_convective_heat_exchanger_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_convective_heat_exchanger_8h_source.html b/doxygen/_convective_heat_exchanger_8h_source.html index 7af58f677..ccf788e57 100644 --- a/doxygen/_convective_heat_exchanger_8h_source.html +++ b/doxygen/_convective_heat_exchanger_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_fission_kernel_8_c.html b/doxygen/_coupled_fission_kernel_8_c.html index 347f9f9b5..b41bf957a 100644 --- a/doxygen/_coupled_fission_kernel_8_c.html +++ b/doxygen/_coupled_fission_kernel_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_fission_kernel_8h.html b/doxygen/_coupled_fission_kernel_8h.html index 4d15a686c..9f501fa57 100644 --- a/doxygen/_coupled_fission_kernel_8h.html +++ b/doxygen/_coupled_fission_kernel_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_fission_kernel_8h_source.html b/doxygen/_coupled_fission_kernel_8h_source.html index d569e37b5..4ba374ffb 100644 --- a/doxygen/_coupled_fission_kernel_8h_source.html +++ b/doxygen/_coupled_fission_kernel_8h_source.html @@ -150,7 +150,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_outflow_b_c_8_c.html b/doxygen/_coupled_outflow_b_c_8_c.html index 52b5f1df3..a0210de38 100644 --- a/doxygen/_coupled_outflow_b_c_8_c.html +++ b/doxygen/_coupled_outflow_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_outflow_b_c_8h.html b/doxygen/_coupled_outflow_b_c_8h.html index 7ffd97abf..dba1f65d2 100644 --- a/doxygen/_coupled_outflow_b_c_8h.html +++ b/doxygen/_coupled_outflow_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_outflow_b_c_8h_source.html b/doxygen/_coupled_outflow_b_c_8h_source.html index 018a459ce..013b5c285 100644 --- a/doxygen/_coupled_outflow_b_c_8h_source.html +++ b/doxygen/_coupled_outflow_b_c_8h_source.html @@ -118,7 +118,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_8_c.html b/doxygen/_coupled_scalar_advection_8_c.html index e13aef802..3e4bc48fe 100644 --- a/doxygen/_coupled_scalar_advection_8_c.html +++ b/doxygen/_coupled_scalar_advection_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_8h.html b/doxygen/_coupled_scalar_advection_8h.html index 1caec2f3f..7ba376fb5 100644 --- a/doxygen/_coupled_scalar_advection_8h.html +++ b/doxygen/_coupled_scalar_advection_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_8h_source.html b/doxygen/_coupled_scalar_advection_8h_source.html index fecf8ff28..8541027e2 100644 --- a/doxygen/_coupled_scalar_advection_8h_source.html +++ b/doxygen/_coupled_scalar_advection_8h_source.html @@ -146,7 +146,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8_c.html b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8_c.html index 9c7442d83..3cfffa6d2 100644 --- a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8_c.html +++ b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h.html b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h.html index ce8556112..1cb89eb05 100644 --- a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h.html +++ b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h_source.html b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h_source.html index 6e16b14d3..07fe4321b 100644 --- a/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h_source.html +++ b/doxygen/_coupled_scalar_advection_no_b_c_b_c_8h_source.html @@ -145,7 +145,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_d_g_turbulent_diffusion_8_c.html b/doxygen/_d_g_turbulent_diffusion_8_c.html index 01ca6c7c8..4809347ec 100644 --- a/doxygen/_d_g_turbulent_diffusion_8_c.html +++ b/doxygen/_d_g_turbulent_diffusion_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_d_g_turbulent_diffusion_8h.html b/doxygen/_d_g_turbulent_diffusion_8h.html index b584b1b49..68183feb7 100644 --- a/doxygen/_d_g_turbulent_diffusion_8h.html +++ b/doxygen/_d_g_turbulent_diffusion_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_d_g_turbulent_diffusion_8h_source.html b/doxygen/_d_g_turbulent_diffusion_8h_source.html index 03bfe0ec0..df9f19985 100644 --- a/doxygen/_d_g_turbulent_diffusion_8h_source.html +++ b/doxygen/_d_g_turbulent_diffusion_8h_source.html @@ -135,7 +135,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_decay_heat_source_8_c.html b/doxygen/_decay_heat_source_8_c.html index 30d394491..a080e835f 100644 --- a/doxygen/_decay_heat_source_8_c.html +++ b/doxygen/_decay_heat_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_decay_heat_source_8h.html b/doxygen/_decay_heat_source_8h.html index 60da70b0e..136245052 100644 --- a/doxygen/_decay_heat_source_8h.html +++ b/doxygen/_decay_heat_source_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_decay_heat_source_8h_source.html b/doxygen/_decay_heat_source_8h_source.html index 5522e8b16..edd2a245a 100644 --- a/doxygen/_decay_heat_source_8h_source.html +++ b/doxygen/_decay_heat_source_8h_source.html @@ -126,7 +126,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_delayed_neutron_source_8_c.html b/doxygen/_delayed_neutron_source_8_c.html index f65d81d2c..73d1828ae 100644 --- a/doxygen/_delayed_neutron_source_8_c.html +++ b/doxygen/_delayed_neutron_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_delayed_neutron_source_8h.html b/doxygen/_delayed_neutron_source_8h.html index 88ff54472..0480d9a4b 100644 --- a/doxygen/_delayed_neutron_source_8h.html +++ b/doxygen/_delayed_neutron_source_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_delayed_neutron_source_8h_source.html b/doxygen/_delayed_neutron_source_8h_source.html index 97d272876..26cd538ce 100644 --- a/doxygen/_delayed_neutron_source_8h_source.html +++ b/doxygen/_delayed_neutron_source_8h_source.html @@ -138,7 +138,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_diffusion_no_b_c_b_c_8_c.html b/doxygen/_diffusion_no_b_c_b_c_8_c.html index 38404f262..ac0d68f0a 100644 --- a/doxygen/_diffusion_no_b_c_b_c_8_c.html +++ b/doxygen/_diffusion_no_b_c_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_diffusion_no_b_c_b_c_8h.html b/doxygen/_diffusion_no_b_c_b_c_8h.html index 2c41787e2..383d5e19d 100644 --- a/doxygen/_diffusion_no_b_c_b_c_8h.html +++ b/doxygen/_diffusion_no_b_c_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_diffusion_no_b_c_b_c_8h_source.html b/doxygen/_diffusion_no_b_c_b_c_8h_source.html index 0595c0d81..eed79811b 100644 --- a/doxygen/_diffusion_no_b_c_b_c_8h_source.html +++ b/doxygen/_diffusion_no_b_c_b_c_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_dirac_h_x_8_c.html b/doxygen/_dirac_h_x_8_c.html index f43892681..0e82cd67f 100644 --- a/doxygen/_dirac_h_x_8_c.html +++ b/doxygen/_dirac_h_x_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_dirac_h_x_8h.html b/doxygen/_dirac_h_x_8h.html index 5b9ff0f2a..cd03d152a 100644 --- a/doxygen/_dirac_h_x_8h.html +++ b/doxygen/_dirac_h_x_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_dirac_h_x_8h_source.html b/doxygen/_dirac_h_x_8h_source.html index 18e94b67d..459dac640 100644 --- a/doxygen/_dirac_h_x_8h_source.html +++ b/doxygen/_dirac_h_x_8h_source.html @@ -118,7 +118,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_div_free_coupled_scalar_advection_8_c.html b/doxygen/_div_free_coupled_scalar_advection_8_c.html index 788597d78..25e09eb10 100644 --- a/doxygen/_div_free_coupled_scalar_advection_8_c.html +++ b/doxygen/_div_free_coupled_scalar_advection_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_div_free_coupled_scalar_advection_8h.html b/doxygen/_div_free_coupled_scalar_advection_8h.html index b8237a447..52c97d471 100644 --- a/doxygen/_div_free_coupled_scalar_advection_8h.html +++ b/doxygen/_div_free_coupled_scalar_advection_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_div_free_coupled_scalar_advection_8h_source.html b/doxygen/_div_free_coupled_scalar_advection_8h_source.html index f3ef75eba..5ab7062e5 100644 --- a/doxygen/_div_free_coupled_scalar_advection_8h_source.html +++ b/doxygen/_div_free_coupled_scalar_advection_8h_source.html @@ -145,7 +145,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8_c.html b/doxygen/_division_postprocessor_8_c.html index e63ba91a5..064ca61aa 100644 --- a/doxygen/_division_postprocessor_8_c.html +++ b/doxygen/_division_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8h.html b/doxygen/_division_postprocessor_8h.html index eb9a77230..f51dd5d05 100644 --- a/doxygen/_division_postprocessor_8h.html +++ b/doxygen/_division_postprocessor_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8h_source.html b/doxygen/_division_postprocessor_8h_source.html index 6d9e1b25d..67358a803 100644 --- a/doxygen/_division_postprocessor_8h_source.html +++ b/doxygen/_division_postprocessor_8h_source.html @@ -112,7 +112,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_element_l2_diff_8_c.html b/doxygen/_element_l2_diff_8_c.html index 408859f43..fb9ee46d6 100644 --- a/doxygen/_element_l2_diff_8_c.html +++ b/doxygen/_element_l2_diff_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_element_l2_diff_8h.html b/doxygen/_element_l2_diff_8h.html index 87e475a1f..515a33a1c 100644 --- a/doxygen/_element_l2_diff_8h.html +++ b/doxygen/_element_l2_diff_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_element_l2_diff_8h_source.html b/doxygen/_element_l2_diff_8h_source.html index 3238de052..cd510330b 100644 --- a/doxygen/_element_l2_diff_8h_source.html +++ b/doxygen/_element_l2_diff_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8_c.html b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8_c.html index e270791fa..a8d1e9ded 100644 --- a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8_c.html +++ b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h.html b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h.html index eece8b649..78914f4ee 100644 --- a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h.html +++ b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h_source.html b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h_source.html index 8a6ce5d45..44b69f1f8 100644 --- a/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h_source.html +++ b/doxygen/_elm_integ_tot_fiss_heat_postprocessor_8h_source.html @@ -115,7 +115,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8_c.html b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8_c.html index e800b8ce8..a0c437315 100644 --- a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8_c.html +++ b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h.html b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h.html index c55a5debd..e316f377d 100644 --- a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h.html +++ b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h_source.html b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h_source.html index aa5a4e854..5448b9ccd 100644 --- a/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h_source.html +++ b/doxygen/_elm_integ_tot_fiss_nts_postprocessor_8h_source.html @@ -142,7 +142,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_postprocessor_8_c.html b/doxygen/_elm_integ_tot_fiss_postprocessor_8_c.html index 9764fcf9a..a04e865fa 100644 --- a/doxygen/_elm_integ_tot_fiss_postprocessor_8_c.html +++ b/doxygen/_elm_integ_tot_fiss_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_postprocessor_8h.html b/doxygen/_elm_integ_tot_fiss_postprocessor_8h.html index 7cf7f57de..ebb5bdc21 100644 --- a/doxygen/_elm_integ_tot_fiss_postprocessor_8h.html +++ b/doxygen/_elm_integ_tot_fiss_postprocessor_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_elm_integ_tot_fiss_postprocessor_8h_source.html b/doxygen/_elm_integ_tot_fiss_postprocessor_8h_source.html index f59281045..841165e51 100644 --- a/doxygen/_elm_integ_tot_fiss_postprocessor_8h_source.html +++ b/doxygen/_elm_integ_tot_fiss_postprocessor_8h_source.html @@ -126,7 +126,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_8_c.html b/doxygen/_fission_heat_source_8_c.html index 302f10d78..0be1797a7 100644 --- a/doxygen/_fission_heat_source_8_c.html +++ b/doxygen/_fission_heat_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_8h.html b/doxygen/_fission_heat_source_8h.html index ce2aec1d2..d8a43d04e 100644 --- a/doxygen/_fission_heat_source_8h.html +++ b/doxygen/_fission_heat_source_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_8h_source.html b/doxygen/_fission_heat_source_8h_source.html index c0baa1dde..d00c7ecc2 100644 --- a/doxygen/_fission_heat_source_8h_source.html +++ b/doxygen/_fission_heat_source_8h_source.html @@ -133,7 +133,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_aux_8_c.html b/doxygen/_fission_heat_source_aux_8_c.html index cab95610a..8954fd60e 100644 --- a/doxygen/_fission_heat_source_aux_8_c.html +++ b/doxygen/_fission_heat_source_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_aux_8h.html b/doxygen/_fission_heat_source_aux_8h.html index f85b8bf43..825e0eff2 100644 --- a/doxygen/_fission_heat_source_aux_8h.html +++ b/doxygen/_fission_heat_source_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_aux_8h_source.html b/doxygen/_fission_heat_source_aux_8h_source.html index 14d2fd02b..c5a6422e6 100644 --- a/doxygen/_fission_heat_source_aux_8h_source.html +++ b/doxygen/_fission_heat_source_aux_8h_source.html @@ -125,7 +125,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_transient_aux_8_c.html b/doxygen/_fission_heat_source_transient_aux_8_c.html index c8927cd59..5c7bbeaaf 100644 --- a/doxygen/_fission_heat_source_transient_aux_8_c.html +++ b/doxygen/_fission_heat_source_transient_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_transient_aux_8h.html b/doxygen/_fission_heat_source_transient_aux_8h.html index f01a3298e..28e013643 100644 --- a/doxygen/_fission_heat_source_transient_aux_8h.html +++ b/doxygen/_fission_heat_source_transient_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_transient_aux_8h_source.html b/doxygen/_fission_heat_source_transient_aux_8h_source.html index dacae3da5..c3a4e900a 100644 --- a/doxygen/_fission_heat_source_transient_aux_8h_source.html +++ b/doxygen/_fission_heat_source_transient_aux_8h_source.html @@ -121,7 +121,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_gamma_heat_source_8_c.html b/doxygen/_gamma_heat_source_8_c.html index 8ec7c4945..82d304d39 100644 --- a/doxygen/_gamma_heat_source_8_c.html +++ b/doxygen/_gamma_heat_source_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_gamma_heat_source_8h.html b/doxygen/_gamma_heat_source_8h.html index 0b9d2ed12..61b058d76 100644 --- a/doxygen/_gamma_heat_source_8h.html +++ b/doxygen/_gamma_heat_source_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_gamma_heat_source_8h_source.html b/doxygen/_gamma_heat_source_8h_source.html index 4b36b28fb..859676476 100644 --- a/doxygen/_gamma_heat_source_8h_source.html +++ b/doxygen/_gamma_heat_source_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_generic_moltres_material_8_c.html b/doxygen/_generic_moltres_material_8_c.html index 92a10a23c..236abf045 100644 --- a/doxygen/_generic_moltres_material_8_c.html +++ b/doxygen/_generic_moltres_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_generic_moltres_material_8h.html b/doxygen/_generic_moltres_material_8h.html index f66c99c57..0e0f8a4ea 100644 --- a/doxygen/_generic_moltres_material_8h.html +++ b/doxygen/_generic_moltres_material_8h.html @@ -111,7 +111,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_generic_moltres_material_8h_source.html b/doxygen/_generic_moltres_material_8h_source.html index ea24df3eb..5d1ed29f8 100644 --- a/doxygen/_generic_moltres_material_8h_source.html +++ b/doxygen/_generic_moltres_material_8h_source.html @@ -150,7 +150,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_graphite_two_grp_x_s_function_material_8_c.html b/doxygen/_graphite_two_grp_x_s_function_material_8_c.html index 2fb82ce24..f7ad33d1f 100644 --- a/doxygen/_graphite_two_grp_x_s_function_material_8_c.html +++ b/doxygen/_graphite_two_grp_x_s_function_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_graphite_two_grp_x_s_function_material_8h.html b/doxygen/_graphite_two_grp_x_s_function_material_8h.html index 580dfbe59..ec88524d5 100644 --- a/doxygen/_graphite_two_grp_x_s_function_material_8h.html +++ b/doxygen/_graphite_two_grp_x_s_function_material_8h.html @@ -111,7 +111,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_graphite_two_grp_x_s_function_material_8h_source.html b/doxygen/_graphite_two_grp_x_s_function_material_8h_source.html index 96926111c..cde6c4de8 100644 --- a/doxygen/_graphite_two_grp_x_s_function_material_8h_source.html +++ b/doxygen/_graphite_two_grp_x_s_function_material_8h_source.html @@ -167,7 +167,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8_c.html b/doxygen/_group_diffusion_8_c.html index bfe86c977..d3fcd47cb 100644 --- a/doxygen/_group_diffusion_8_c.html +++ b/doxygen/_group_diffusion_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8h.html b/doxygen/_group_diffusion_8h.html index c155a889e..0ff057e02 100644 --- a/doxygen/_group_diffusion_8h.html +++ b/doxygen/_group_diffusion_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8h_source.html b/doxygen/_group_diffusion_8h_source.html index d4aca731d..b760afaee 100644 --- a/doxygen/_group_diffusion_8h_source.html +++ b/doxygen/_group_diffusion_8h_source.html @@ -126,7 +126,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_decay_8_c.html b/doxygen/_heat_precursor_decay_8_c.html index 4d48cf692..75bde3c8c 100644 --- a/doxygen/_heat_precursor_decay_8_c.html +++ b/doxygen/_heat_precursor_decay_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_decay_8h.html b/doxygen/_heat_precursor_decay_8h.html index 860bbbffd..e8569ec86 100644 --- a/doxygen/_heat_precursor_decay_8h.html +++ b/doxygen/_heat_precursor_decay_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_decay_8h_source.html b/doxygen/_heat_precursor_decay_8h_source.html index 0dd01a8e2..1adc5d11d 100644 --- a/doxygen/_heat_precursor_decay_8h_source.html +++ b/doxygen/_heat_precursor_decay_8h_source.html @@ -120,7 +120,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_source_8_c.html b/doxygen/_heat_precursor_source_8_c.html index a9905172a..5d0a166af 100644 --- a/doxygen/_heat_precursor_source_8_c.html +++ b/doxygen/_heat_precursor_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_source_8h.html b/doxygen/_heat_precursor_source_8h.html index 79c8874c8..6d9d1d287 100644 --- a/doxygen/_heat_precursor_source_8h.html +++ b/doxygen/_heat_precursor_source_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_source_8h_source.html b/doxygen/_heat_precursor_source_8h_source.html index d94cd768f..44f682644 100644 --- a/doxygen/_heat_precursor_source_8h_source.html +++ b/doxygen/_heat_precursor_source_8h_source.html @@ -146,7 +146,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8_c.html b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8_c.html index 7c1de6299..073cc951a 100644 --- a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8_c.html +++ b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h.html b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h.html index e2e9c6bf1..5345994e6 100644 --- a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h.html +++ b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h_source.html b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h_source.html index 5192b2517..06c2c9430 100644 --- a/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h_source.html +++ b/doxygen/_i_n_s_a_d_energy_turbulent_diffusion_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8_c.html b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8_c.html index f8841f091..5d9d39529 100644 --- a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8_c.html +++ b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h.html b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h.html index 49a233ca5..f352f6338 100644 --- a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h.html +++ b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h_source.html b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h_source.html index cdc2d0c56..122dd857d 100644 --- a/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h_source.html +++ b/doxygen/_i_n_s_a_d_mass_p_s_p_g_b_c_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8_c.html b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8_c.html index 63a390dde..037a85c1f 100644 --- a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8_c.html +++ b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h.html b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h.html index 9842ce1ca..530f82587 100644 --- a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h.html +++ b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h_source.html b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h_source.html index ee3bd8583..3c2823e90 100644 --- a/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h_source.html +++ b/doxygen/_i_n_s_a_d_momentum_s_u_p_g_b_c_8h_source.html @@ -125,7 +125,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8_c.html b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8_c.html index 069cdb7ae..c670ffd69 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8_c.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h.html b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h.html index 2fb118e05..ec261aa1a 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h_source.html b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h_source.html index 50a106763..1016ebeb2 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h_source.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_no_b_c_b_c_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8_c.html b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8_c.html index 933bbf159..5ef7595cd 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8_c.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h.html b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h.html index 34cdada7a..2ebb81173 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h_source.html b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h_source.html index 1f67ce4f5..f80e50f9d 100644 --- a/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h_source.html +++ b/doxygen/_i_n_s_a_d_momentum_turbulent_viscous_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_boussinesq_body_force_8_c.html b/doxygen/_i_n_s_boussinesq_body_force_8_c.html index 2f2a67d93..eb6b233c5 100644 --- a/doxygen/_i_n_s_boussinesq_body_force_8_c.html +++ b/doxygen/_i_n_s_boussinesq_body_force_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_boussinesq_body_force_8h.html b/doxygen/_i_n_s_boussinesq_body_force_8h.html index ed7cda371..af47d7ada 100644 --- a/doxygen/_i_n_s_boussinesq_body_force_8h.html +++ b/doxygen/_i_n_s_boussinesq_body_force_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_i_n_s_boussinesq_body_force_8h_source.html b/doxygen/_i_n_s_boussinesq_body_force_8h_source.html index 0ab5bb3b7..69e83bd22 100644 --- a/doxygen/_i_n_s_boussinesq_body_force_8h_source.html +++ b/doxygen/_i_n_s_boussinesq_body_force_8h_source.html @@ -135,7 +135,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8_c.html b/doxygen/_in_scatter_8_c.html index 6d68a5019..702b908e8 100644 --- a/doxygen/_in_scatter_8_c.html +++ b/doxygen/_in_scatter_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8h.html b/doxygen/_in_scatter_8h.html index 3a2328cb8..3fa51d7fe 100644 --- a/doxygen/_in_scatter_8h.html +++ b/doxygen/_in_scatter_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8h_source.html b/doxygen/_in_scatter_8h_source.html index df5303e11..94751cfa8 100644 --- a/doxygen/_in_scatter_8h_source.html +++ b/doxygen/_in_scatter_8h_source.html @@ -134,7 +134,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_new_variable_postprocessor_8_c.html b/doxygen/_integral_new_variable_postprocessor_8_c.html index 52f50962f..bc0dad191 100644 --- a/doxygen/_integral_new_variable_postprocessor_8_c.html +++ b/doxygen/_integral_new_variable_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_new_variable_postprocessor_8h.html b/doxygen/_integral_new_variable_postprocessor_8h.html index c72a9fa42..5c57e33bb 100644 --- a/doxygen/_integral_new_variable_postprocessor_8h.html +++ b/doxygen/_integral_new_variable_postprocessor_8h.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_new_variable_postprocessor_8h_source.html b/doxygen/_integral_new_variable_postprocessor_8h_source.html index bf7ce6237..d8e89d872 100644 --- a/doxygen/_integral_new_variable_postprocessor_8h_source.html +++ b/doxygen/_integral_new_variable_postprocessor_8h_source.html @@ -123,7 +123,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_old_variable_postprocessor_8_c.html b/doxygen/_integral_old_variable_postprocessor_8_c.html index 1807935b9..ff55b1c51 100644 --- a/doxygen/_integral_old_variable_postprocessor_8_c.html +++ b/doxygen/_integral_old_variable_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_old_variable_postprocessor_8h.html b/doxygen/_integral_old_variable_postprocessor_8h.html index b796f9fad..75a791aa3 100644 --- a/doxygen/_integral_old_variable_postprocessor_8h.html +++ b/doxygen/_integral_old_variable_postprocessor_8h.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_integral_old_variable_postprocessor_8h_source.html b/doxygen/_integral_old_variable_postprocessor_8h_source.html index 9f3b5e92d..ef7db800e 100644 --- a/doxygen/_integral_old_variable_postprocessor_8h_source.html +++ b/doxygen/_integral_old_variable_postprocessor_8h_source.html @@ -121,7 +121,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8_c.html b/doxygen/_limit_k_8_c.html index 89194871c..6d65c23d1 100644 --- a/doxygen/_limit_k_8_c.html +++ b/doxygen/_limit_k_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8h.html b/doxygen/_limit_k_8h.html index 5f8e8471b..f595860f5 100644 --- a/doxygen/_limit_k_8h.html +++ b/doxygen/_limit_k_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8h_source.html b/doxygen/_limit_k_8h_source.html index 7fe31e9a2..47c94a967 100644 --- a/doxygen/_limit_k_8h_source.html +++ b/doxygen/_limit_k_8h_source.html @@ -139,7 +139,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_lin_log_penalty_dirichlet_b_c_8_c.html b/doxygen/_lin_log_penalty_dirichlet_b_c_8_c.html index f195f705c..55cf0d3d2 100644 --- a/doxygen/_lin_log_penalty_dirichlet_b_c_8_c.html +++ b/doxygen/_lin_log_penalty_dirichlet_b_c_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_lin_log_penalty_dirichlet_b_c_8h.html b/doxygen/_lin_log_penalty_dirichlet_b_c_8h.html index 26e439b7c..bf9351f3d 100644 --- a/doxygen/_lin_log_penalty_dirichlet_b_c_8h.html +++ b/doxygen/_lin_log_penalty_dirichlet_b_c_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_lin_log_penalty_dirichlet_b_c_8h_source.html b/doxygen/_lin_log_penalty_dirichlet_b_c_8h_source.html index bb38a7ca4..6f336d632 100644 --- a/doxygen/_lin_log_penalty_dirichlet_b_c_8h_source.html +++ b/doxygen/_lin_log_penalty_dirichlet_b_c_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_aux_8_c.html b/doxygen/_mat_diffusion_aux_8_c.html index b1708d110..bed41f5b7 100644 --- a/doxygen/_mat_diffusion_aux_8_c.html +++ b/doxygen/_mat_diffusion_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_aux_8h.html b/doxygen/_mat_diffusion_aux_8h.html index d7317af8c..8c5920dbc 100644 --- a/doxygen/_mat_diffusion_aux_8h.html +++ b/doxygen/_mat_diffusion_aux_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_aux_8h_source.html b/doxygen/_mat_diffusion_aux_8h_source.html index 9d3df9755..958ed74a1 100644 --- a/doxygen/_mat_diffusion_aux_8h_source.html +++ b/doxygen/_mat_diffusion_aux_8h_source.html @@ -118,7 +118,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_flux_b_c_8_c.html b/doxygen/_mat_diffusion_flux_b_c_8_c.html index 64fc2ac4b..999a75239 100644 --- a/doxygen/_mat_diffusion_flux_b_c_8_c.html +++ b/doxygen/_mat_diffusion_flux_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_flux_b_c_8h.html b/doxygen/_mat_diffusion_flux_b_c_8h.html index 1e618e067..7c701f3d0 100644 --- a/doxygen/_mat_diffusion_flux_b_c_8h.html +++ b/doxygen/_mat_diffusion_flux_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_flux_b_c_8h_source.html b/doxygen/_mat_diffusion_flux_b_c_8h_source.html index 9302f6cd2..cd8c99bc4 100644 --- a/doxygen/_mat_diffusion_flux_b_c_8h_source.html +++ b/doxygen/_mat_diffusion_flux_b_c_8h_source.html @@ -114,7 +114,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moderator_heat_source_transient_aux_8_c.html b/doxygen/_moderator_heat_source_transient_aux_8_c.html index 97675b965..1d3f4a1d8 100644 --- a/doxygen/_moderator_heat_source_transient_aux_8_c.html +++ b/doxygen/_moderator_heat_source_transient_aux_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moderator_heat_source_transient_aux_8h.html b/doxygen/_moderator_heat_source_transient_aux_8h.html index e936942f8..87090b61f 100644 --- a/doxygen/_moderator_heat_source_transient_aux_8h.html +++ b/doxygen/_moderator_heat_source_transient_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moderator_heat_source_transient_aux_8h_source.html b/doxygen/_moderator_heat_source_transient_aux_8h_source.html index c9d60ec64..34722afdd 100644 --- a/doxygen/_moderator_heat_source_transient_aux_8h_source.html +++ b/doxygen/_moderator_heat_source_transient_aux_8h_source.html @@ -115,7 +115,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8_c.html b/doxygen/_moltres_app_8_c.html index 8d9ed2fd0..7249dafb1 100644 --- a/doxygen/_moltres_app_8_c.html +++ b/doxygen/_moltres_app_8_c.html @@ -179,7 +179,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8h.html b/doxygen/_moltres_app_8h.html index c56308a49..77cbd279e 100644 --- a/doxygen/_moltres_app_8h.html +++ b/doxygen/_moltres_app_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8h_source.html b/doxygen/_moltres_app_8h_source.html index 7fc67769b..638aab2e3 100644 --- a/doxygen/_moltres_app_8h_source.html +++ b/doxygen/_moltres_app_8h_source.html @@ -114,7 +114,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_json_material_8_c.html b/doxygen/_moltres_json_material_8_c.html index 79adca50d..c25c15272 100644 --- a/doxygen/_moltres_json_material_8_c.html +++ b/doxygen/_moltres_json_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_json_material_8h.html b/doxygen/_moltres_json_material_8h.html index b25c4b8b9..47b1a552b 100644 --- a/doxygen/_moltres_json_material_8h.html +++ b/doxygen/_moltres_json_material_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_json_material_8h_source.html b/doxygen/_moltres_json_material_8h_source.html index 2400f20af..3c5ce1e06 100644 --- a/doxygen/_moltres_json_material_8h_source.html +++ b/doxygen/_moltres_json_material_8h_source.html @@ -123,7 +123,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_msre_fuel_two_grp_x_s_function_material_8_c.html b/doxygen/_msre_fuel_two_grp_x_s_function_material_8_c.html index 704c296db..d1447f6ed 100644 --- a/doxygen/_msre_fuel_two_grp_x_s_function_material_8_c.html +++ b/doxygen/_msre_fuel_two_grp_x_s_function_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_msre_fuel_two_grp_x_s_function_material_8h.html b/doxygen/_msre_fuel_two_grp_x_s_function_material_8h.html index 93cf077b2..9bcb01b19 100644 --- a/doxygen/_msre_fuel_two_grp_x_s_function_material_8h.html +++ b/doxygen/_msre_fuel_two_grp_x_s_function_material_8h.html @@ -111,7 +111,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_msre_fuel_two_grp_x_s_function_material_8h_source.html b/doxygen/_msre_fuel_two_grp_x_s_function_material_8h_source.html index c60c88d56..e6866d5dc 100644 --- a/doxygen/_msre_fuel_two_grp_x_s_function_material_8h_source.html +++ b/doxygen/_msre_fuel_two_grp_x_s_function_material_8h_source.html @@ -169,7 +169,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8_c.html b/doxygen/_neutron_leakage_8_c.html index 3971eec5c..72944e010 100644 --- a/doxygen/_neutron_leakage_8_c.html +++ b/doxygen/_neutron_leakage_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8h.html b/doxygen/_neutron_leakage_8h.html index ee2f1f33c..608be392c 100644 --- a/doxygen/_neutron_leakage_8h.html +++ b/doxygen/_neutron_leakage_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8h_source.html b/doxygen/_neutron_leakage_8h_source.html index 7f4875c70..2f6689540 100644 --- a/doxygen/_neutron_leakage_8h_source.html +++ b/doxygen/_neutron_leakage_8h_source.html @@ -115,7 +115,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8_c.html b/doxygen/_nt_action_8_c.html index 6aa1ab098..042a9383a 100644 --- a/doxygen/_nt_action_8_c.html +++ b/doxygen/_nt_action_8_c.html @@ -395,7 +395,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8h.html b/doxygen/_nt_action_8h.html index d39f14878..b249a159e 100644 --- a/doxygen/_nt_action_8h.html +++ b/doxygen/_nt_action_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8h_source.html b/doxygen/_nt_action_8h_source.html index 5aabf7de9..7ff1be604 100644 --- a/doxygen/_nt_action_8h_source.html +++ b/doxygen/_nt_action_8h_source.html @@ -135,7 +135,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_time_derivative_8_c.html b/doxygen/_nt_time_derivative_8_c.html index 671019bd9..56cd9e898 100644 --- a/doxygen/_nt_time_derivative_8_c.html +++ b/doxygen/_nt_time_derivative_8_c.html @@ -131,7 +131,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_time_derivative_8h.html b/doxygen/_nt_time_derivative_8h.html index 15e6da99e..e77235174 100644 --- a/doxygen/_nt_time_derivative_8h.html +++ b/doxygen/_nt_time_derivative_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_time_derivative_8h_source.html b/doxygen/_nt_time_derivative_8h_source.html index 1c80c1d0a..cef0a9174 100644 --- a/doxygen/_nt_time_derivative_8h_source.html +++ b/doxygen/_nt_time_derivative_8h_source.html @@ -125,7 +125,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8_c.html b/doxygen/_nuclear_material_8_c.html index 26268a3c0..7bc94181c 100644 --- a/doxygen/_nuclear_material_8_c.html +++ b/doxygen/_nuclear_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8h.html b/doxygen/_nuclear_material_8h.html index e2a191c6f..14775fc45 100644 --- a/doxygen/_nuclear_material_8h.html +++ b/doxygen/_nuclear_material_8h.html @@ -112,7 +112,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8h_source.html b/doxygen/_nuclear_material_8h_source.html index 39bc55305..8011d7961 100644 --- a/doxygen/_nuclear_material_8h_source.html +++ b/doxygen/_nuclear_material_8h_source.html @@ -288,7 +288,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8_c.html b/doxygen/_nusselt_8_c.html index 868a60614..fdaa6f9a3 100644 --- a/doxygen/_nusselt_8_c.html +++ b/doxygen/_nusselt_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8h.html b/doxygen/_nusselt_8h.html index ff34e3174..5370b9470 100644 --- a/doxygen/_nusselt_8h.html +++ b/doxygen/_nusselt_8h.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8h_source.html b/doxygen/_nusselt_8h_source.html index 4fe288440..12aa72a00 100644 --- a/doxygen/_nusselt_8h_source.html +++ b/doxygen/_nusselt_8h_source.html @@ -121,7 +121,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_postprocessor_coupled_inflow_b_c_8_c.html b/doxygen/_postprocessor_coupled_inflow_b_c_8_c.html index 43fa9a897..8ffe96508 100644 --- a/doxygen/_postprocessor_coupled_inflow_b_c_8_c.html +++ b/doxygen/_postprocessor_coupled_inflow_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_postprocessor_coupled_inflow_b_c_8h.html b/doxygen/_postprocessor_coupled_inflow_b_c_8h.html index d1907ad8a..f8870ce53 100644 --- a/doxygen/_postprocessor_coupled_inflow_b_c_8h.html +++ b/doxygen/_postprocessor_coupled_inflow_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_postprocessor_coupled_inflow_b_c_8h_source.html b/doxygen/_postprocessor_coupled_inflow_b_c_8h_source.html index d6c498940..e64d4141b 100644 --- a/doxygen/_postprocessor_coupled_inflow_b_c_8h_source.html +++ b/doxygen/_postprocessor_coupled_inflow_b_c_8h_source.html @@ -124,7 +124,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8_c.html b/doxygen/_precursor_action_8_c.html index 6675adba7..415d40872 100644 --- a/doxygen/_precursor_action_8_c.html +++ b/doxygen/_precursor_action_8_c.html @@ -429,7 +429,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8h.html b/doxygen/_precursor_action_8h.html index f5f4fd942..0c3f7037f 100644 --- a/doxygen/_precursor_action_8h.html +++ b/doxygen/_precursor_action_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8h_source.html b/doxygen/_precursor_action_8h_source.html index 741a79216..ed8d37016 100644 --- a/doxygen/_precursor_action_8h_source.html +++ b/doxygen/_precursor_action_8h_source.html @@ -167,7 +167,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8_c.html b/doxygen/_precursor_decay_8_c.html index 43df46a1f..26ac2ed48 100644 --- a/doxygen/_precursor_decay_8_c.html +++ b/doxygen/_precursor_decay_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8h.html b/doxygen/_precursor_decay_8h.html index 759b4e3bd..fea555641 100644 --- a/doxygen/_precursor_decay_8h.html +++ b/doxygen/_precursor_decay_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8h_source.html b/doxygen/_precursor_decay_8h_source.html index 08ab94000..b1b928724 100644 --- a/doxygen/_precursor_decay_8h_source.html +++ b/doxygen/_precursor_decay_8h_source.html @@ -130,7 +130,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8_c.html b/doxygen/_precursor_source_8_c.html index 0fb8c1e51..e94cf4999 100644 --- a/doxygen/_precursor_source_8_c.html +++ b/doxygen/_precursor_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8h.html b/doxygen/_precursor_source_8h.html index 539c1f85d..cb32cdd53 100644 --- a/doxygen/_precursor_source_8h.html +++ b/doxygen/_precursor_source_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8h_source.html b/doxygen/_precursor_source_8h_source.html index 55ba24818..33d93a518 100644 --- a/doxygen/_precursor_source_8h_source.html +++ b/doxygen/_precursor_source_8h_source.html @@ -142,7 +142,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8_c.html b/doxygen/_rodded_material_8_c.html index 1969d35ff..9cc2a5eac 100644 --- a/doxygen/_rodded_material_8_c.html +++ b/doxygen/_rodded_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8h.html b/doxygen/_rodded_material_8h.html index d3313538c..0b5674075 100644 --- a/doxygen/_rodded_material_8h.html +++ b/doxygen/_rodded_material_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8h_source.html b/doxygen/_rodded_material_8h_source.html index 1f5e7c795..6eaf46860 100644 --- a/doxygen/_rodded_material_8h_source.html +++ b/doxygen/_rodded_material_8h_source.html @@ -124,7 +124,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_material_8_c.html b/doxygen/_s_a_tau_material_8_c.html index c1dc31af2..76a4e264c 100644 --- a/doxygen/_s_a_tau_material_8_c.html +++ b/doxygen/_s_a_tau_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_material_8h.html b/doxygen/_s_a_tau_material_8h.html index eae839c37..12e29f66e 100644 --- a/doxygen/_s_a_tau_material_8h.html +++ b/doxygen/_s_a_tau_material_8h.html @@ -128,7 +128,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_material_8h_source.html b/doxygen/_s_a_tau_material_8h_source.html index 05603ad8f..3b1e31662 100644 --- a/doxygen/_s_a_tau_material_8h_source.html +++ b/doxygen/_s_a_tau_material_8h_source.html @@ -343,7 +343,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_stabilized3_eqn_8_c.html b/doxygen/_s_a_tau_stabilized3_eqn_8_c.html index 9b8fead37..647b2200c 100644 --- a/doxygen/_s_a_tau_stabilized3_eqn_8_c.html +++ b/doxygen/_s_a_tau_stabilized3_eqn_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_stabilized3_eqn_8h.html b/doxygen/_s_a_tau_stabilized3_eqn_8h.html index e1233c9c4..a1221e1f1 100644 --- a/doxygen/_s_a_tau_stabilized3_eqn_8h.html +++ b/doxygen/_s_a_tau_stabilized3_eqn_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_tau_stabilized3_eqn_8h_source.html b/doxygen/_s_a_tau_stabilized3_eqn_8h_source.html index 420532dd2..d1f50f8fb 100644 --- a/doxygen/_s_a_tau_stabilized3_eqn_8h_source.html +++ b/doxygen/_s_a_tau_stabilized3_eqn_8h_source.html @@ -132,7 +132,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_time_derivative_8_c.html b/doxygen/_s_a_time_derivative_8_c.html index 58fefdeae..33bdf7678 100644 --- a/doxygen/_s_a_time_derivative_8_c.html +++ b/doxygen/_s_a_time_derivative_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_time_derivative_8h.html b/doxygen/_s_a_time_derivative_8h.html index 981722b7d..2b6c0cbf1 100644 --- a/doxygen/_s_a_time_derivative_8h.html +++ b/doxygen/_s_a_time_derivative_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_time_derivative_8h_source.html b/doxygen/_s_a_time_derivative_8h_source.html index 4cbd22a01..2d6b5e5f5 100644 --- a/doxygen/_s_a_time_derivative_8h_source.html +++ b/doxygen/_s_a_time_derivative_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_8_c.html b/doxygen/_s_a_turbulent_viscosity_8_c.html index 0eae7195a..167b6c1fb 100644 --- a/doxygen/_s_a_turbulent_viscosity_8_c.html +++ b/doxygen/_s_a_turbulent_viscosity_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_8h.html b/doxygen/_s_a_turbulent_viscosity_8h.html index 6bc6ef398..313b8b2cb 100644 --- a/doxygen/_s_a_turbulent_viscosity_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_8h_source.html b/doxygen/_s_a_turbulent_viscosity_8h_source.html index 791cc06e3..b40894fd9 100644 --- a/doxygen/_s_a_turbulent_viscosity_8h_source.html +++ b/doxygen/_s_a_turbulent_viscosity_8h_source.html @@ -121,7 +121,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_aux_8_c.html b/doxygen/_s_a_turbulent_viscosity_aux_8_c.html index 60b023e0f..eb90f9e0e 100644 --- a/doxygen/_s_a_turbulent_viscosity_aux_8_c.html +++ b/doxygen/_s_a_turbulent_viscosity_aux_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_aux_8h.html b/doxygen/_s_a_turbulent_viscosity_aux_8h.html index 0b9477dfa..454cb4cfd 100644 --- a/doxygen/_s_a_turbulent_viscosity_aux_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_aux_8h_source.html b/doxygen/_s_a_turbulent_viscosity_aux_8h_source.html index be2cb2f55..d5d00f809 100644 --- a/doxygen/_s_a_turbulent_viscosity_aux_8h_source.html +++ b/doxygen/_s_a_turbulent_viscosity_aux_8h_source.html @@ -118,7 +118,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8_c.html b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8_c.html index 045f9091f..1ebb17686 100644 --- a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8_c.html +++ b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h.html b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h.html index 2773b3f46..e97397ddc 100644 --- a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h_source.html b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h_source.html index b479b2326..619f8b185 100644 --- a/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h_source.html +++ b/doxygen/_s_a_turbulent_viscosity_no_b_c_b_c_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8_c.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8_c.html index 0a9293545..703b92f5c 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8_c.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h.html index d7a89d4ee..7372c9678 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h_source.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h_source.html index f059cb286..cfc3a3ef0 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h_source.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8_c.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8_c.html index 97bc3cfcd..c7984bab8 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8_c.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h.html index 3bfba9a9d..f1daa3132 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h_source.html b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h_source.html index fdb222ee5..9d516ba06 100644 --- a/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h_source.html +++ b/doxygen/_s_a_turbulent_viscosity_s_u_p_g_b_c_8h_source.html @@ -125,7 +125,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_8_c.html b/doxygen/_scalar_advection_art_diff_8_c.html index 8a1e4ba93..2fb5223bc 100644 --- a/doxygen/_scalar_advection_art_diff_8_c.html +++ b/doxygen/_scalar_advection_art_diff_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_8h.html b/doxygen/_scalar_advection_art_diff_8h.html index 811ed6e6a..69b466ab1 100644 --- a/doxygen/_scalar_advection_art_diff_8h.html +++ b/doxygen/_scalar_advection_art_diff_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_8h_source.html b/doxygen/_scalar_advection_art_diff_8h_source.html index e41a47fd5..a1a1ea0e7 100644 --- a/doxygen/_scalar_advection_art_diff_8h_source.html +++ b/doxygen/_scalar_advection_art_diff_8h_source.html @@ -153,7 +153,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8_c.html b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8_c.html index a1464cc9a..7516bb5e7 100644 --- a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8_c.html +++ b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h.html b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h.html index b4c690397..0db9561cc 100644 --- a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h.html +++ b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h_source.html b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h_source.html index a90f0f253..9bc74a142 100644 --- a/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h_source.html +++ b/doxygen/_scalar_advection_art_diff_no_b_c_b_c_8h_source.html @@ -149,7 +149,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_base_8_c.html b/doxygen/_scalar_transport_base_8_c.html index ec3ab01b9..b5c9a26bc 100644 --- a/doxygen/_scalar_transport_base_8_c.html +++ b/doxygen/_scalar_transport_base_8_c.html @@ -93,7 +93,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_base_8h.html b/doxygen/_scalar_transport_base_8h.html index aae9120bf..413ae99c8 100644 --- a/doxygen/_scalar_transport_base_8h.html +++ b/doxygen/_scalar_transport_base_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_base_8h_source.html b/doxygen/_scalar_transport_base_8h_source.html index a590068b4..322c884e4 100644 --- a/doxygen/_scalar_transport_base_8h_source.html +++ b/doxygen/_scalar_transport_base_8h_source.html @@ -145,7 +145,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_time_derivative_8_c.html b/doxygen/_scalar_transport_time_derivative_8_c.html index 88f40d7c2..976ab4040 100644 --- a/doxygen/_scalar_transport_time_derivative_8_c.html +++ b/doxygen/_scalar_transport_time_derivative_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_time_derivative_8h.html b/doxygen/_scalar_transport_time_derivative_8h.html index 4de244764..7ab8423d7 100644 --- a/doxygen/_scalar_transport_time_derivative_8h.html +++ b/doxygen/_scalar_transport_time_derivative_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_time_derivative_8h_source.html b/doxygen/_scalar_transport_time_derivative_8h_source.html index f854fd940..130ba78d3 100644 --- a/doxygen/_scalar_transport_time_derivative_8h_source.html +++ b/doxygen/_scalar_transport_time_derivative_8h_source.html @@ -120,7 +120,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_side_weighted_integral_postprocessor_8_c.html b/doxygen/_side_weighted_integral_postprocessor_8_c.html index b82eaf8e2..c1e7d7874 100644 --- a/doxygen/_side_weighted_integral_postprocessor_8_c.html +++ b/doxygen/_side_weighted_integral_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_side_weighted_integral_postprocessor_8h.html b/doxygen/_side_weighted_integral_postprocessor_8h.html index ce77dcb12..737bbd1b1 100644 --- a/doxygen/_side_weighted_integral_postprocessor_8h.html +++ b/doxygen/_side_weighted_integral_postprocessor_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_side_weighted_integral_postprocessor_8h_source.html b/doxygen/_side_weighted_integral_postprocessor_8h_source.html index 5f2482458..93d0745e4 100644 --- a/doxygen/_side_weighted_integral_postprocessor_8h_source.html +++ b/doxygen/_side_weighted_integral_postprocessor_8h_source.html @@ -114,7 +114,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8_c.html b/doxygen/_sigma_r_8_c.html index 9fd2514a2..4566f2dea 100644 --- a/doxygen/_sigma_r_8_c.html +++ b/doxygen/_sigma_r_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8h.html b/doxygen/_sigma_r_8h.html index 8d83ba757..8865e9c67 100644 --- a/doxygen/_sigma_r_8h.html +++ b/doxygen/_sigma_r_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8h_source.html b/doxygen/_sigma_r_8h_source.html index d5fc6d78f..b03a5eebd 100644 --- a/doxygen/_sigma_r_8h_source.html +++ b/doxygen/_sigma_r_8h_source.html @@ -126,7 +126,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_total_neutron_leakage_8_c.html b/doxygen/_total_neutron_leakage_8_c.html index 27672ead5..2adf95888 100644 --- a/doxygen/_total_neutron_leakage_8_c.html +++ b/doxygen/_total_neutron_leakage_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_total_neutron_leakage_8h.html b/doxygen/_total_neutron_leakage_8h.html index 316c98343..b5f43850f 100644 --- a/doxygen/_total_neutron_leakage_8h.html +++ b/doxygen/_total_neutron_leakage_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_total_neutron_leakage_8h_source.html b/doxygen/_total_neutron_leakage_8h_source.html index dcdb49062..499318e9b 100644 --- a/doxygen/_total_neutron_leakage_8h_source.html +++ b/doxygen/_total_neutron_leakage_8h_source.html @@ -124,7 +124,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_transient_fission_heat_source_8_c.html b/doxygen/_transient_fission_heat_source_8_c.html index 647720c54..57d250358 100644 --- a/doxygen/_transient_fission_heat_source_8_c.html +++ b/doxygen/_transient_fission_heat_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_transient_fission_heat_source_8h.html b/doxygen/_transient_fission_heat_source_8h.html index f3b5695dc..dda92b62e 100644 --- a/doxygen/_transient_fission_heat_source_8h.html +++ b/doxygen/_transient_fission_heat_source_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_transient_fission_heat_source_8h_source.html b/doxygen/_transient_fission_heat_source_8h_source.html index 8b529b1c5..fda4cdbea 100644 --- a/doxygen/_transient_fission_heat_source_8h_source.html +++ b/doxygen/_transient_fission_heat_source_8h_source.html @@ -148,7 +148,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_turbulent_stress_aux_8_c.html b/doxygen/_turbulent_stress_aux_8_c.html index 97a32bbcb..c025c9b5b 100644 --- a/doxygen/_turbulent_stress_aux_8_c.html +++ b/doxygen/_turbulent_stress_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_turbulent_stress_aux_8h.html b/doxygen/_turbulent_stress_aux_8h.html index ee89e2e94..270d829bc 100644 --- a/doxygen/_turbulent_stress_aux_8h.html +++ b/doxygen/_turbulent_stress_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_turbulent_stress_aux_8h_source.html b/doxygen/_turbulent_stress_aux_8h_source.html index 53a53b3e6..92baaba7d 100644 --- a/doxygen/_turbulent_stress_aux_8h_source.html +++ b/doxygen/_turbulent_stress_aux_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_vacuum_conc_b_c_8_c.html b/doxygen/_vacuum_conc_b_c_8_c.html index 05cef9b30..fb2612a36 100644 --- a/doxygen/_vacuum_conc_b_c_8_c.html +++ b/doxygen/_vacuum_conc_b_c_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_vacuum_conc_b_c_8h.html b/doxygen/_vacuum_conc_b_c_8h.html index 3e823d81e..e217fadec 100644 --- a/doxygen/_vacuum_conc_b_c_8h.html +++ b/doxygen/_vacuum_conc_b_c_8h.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_vacuum_conc_b_c_8h_source.html b/doxygen/_vacuum_conc_b_c_8h_source.html index 17b3dc4ff..561ae5a0d 100644 --- a/doxygen/_vacuum_conc_b_c_8h_source.html +++ b/doxygen/_vacuum_conc_b_c_8h_source.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_variable_not_a_moose_object_action_8_c.html b/doxygen/_variable_not_a_moose_object_action_8_c.html index c785258c9..cad380d45 100644 --- a/doxygen/_variable_not_a_moose_object_action_8_c.html +++ b/doxygen/_variable_not_a_moose_object_action_8_c.html @@ -96,7 +96,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_variable_not_a_moose_object_action_8h.html b/doxygen/_variable_not_a_moose_object_action_8h.html index f27a3caed..31e71a62f 100644 --- a/doxygen/_variable_not_a_moose_object_action_8h.html +++ b/doxygen/_variable_not_a_moose_object_action_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_variable_not_a_moose_object_action_8h_source.html b/doxygen/_variable_not_a_moose_object_action_8h_source.html index c29e98725..4901dfd42 100644 --- a/doxygen/_variable_not_a_moose_object_action_8h_source.html +++ b/doxygen/_variable_not_a_moose_object_action_8h_source.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_distance_aux_8_c.html b/doxygen/_wall_distance_aux_8_c.html index 6a73f6263..187557bd3 100644 --- a/doxygen/_wall_distance_aux_8_c.html +++ b/doxygen/_wall_distance_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_distance_aux_8h.html b/doxygen/_wall_distance_aux_8h.html index 05bb08e73..ae3cd73e8 100644 --- a/doxygen/_wall_distance_aux_8h.html +++ b/doxygen/_wall_distance_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_distance_aux_8h_source.html b/doxygen/_wall_distance_aux_8h_source.html index 1d05d2055..1e35f9707 100644 --- a/doxygen/_wall_distance_aux_8h_source.html +++ b/doxygen/_wall_distance_aux_8h_source.html @@ -116,7 +116,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_shear_stress_aux_8_c.html b/doxygen/_wall_shear_stress_aux_8_c.html index e8a0274c7..2446f5db5 100644 --- a/doxygen/_wall_shear_stress_aux_8_c.html +++ b/doxygen/_wall_shear_stress_aux_8_c.html @@ -130,7 +130,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_shear_stress_aux_8h.html b/doxygen/_wall_shear_stress_aux_8h.html index 9466484e0..54d7e4e16 100644 --- a/doxygen/_wall_shear_stress_aux_8h.html +++ b/doxygen/_wall_shear_stress_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_shear_stress_aux_8h_source.html b/doxygen/_wall_shear_stress_aux_8h_source.html index 27d43f659..0251162d9 100644 --- a/doxygen/_wall_shear_stress_aux_8h_source.html +++ b/doxygen/_wall_shear_stress_aux_8h_source.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/annotated.html b/doxygen/annotated.html index 343280451..d3c1f7f64 100644 --- a/doxygen/annotated.html +++ b/doxygen/annotated.html @@ -164,7 +164,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_average_fission_heat-members.html b/doxygen/class_average_fission_heat-members.html index b71f04df2..2b9db5c0b 100644 --- a/doxygen/class_average_fission_heat-members.html +++ b/doxygen/class_average_fission_heat-members.html @@ -110,7 +110,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_average_fission_heat.html b/doxygen/class_average_fission_heat.html index f4718a587..f53bbabd6 100644 --- a/doxygen/class_average_fission_heat.html +++ b/doxygen/class_average_fission_heat.html @@ -378,7 +378,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_fuel-members.html b/doxygen/class_cammi_fuel-members.html index ef2249785..4f8b19a8c 100644 --- a/doxygen/class_cammi_fuel-members.html +++ b/doxygen/class_cammi_fuel-members.html @@ -170,7 +170,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_fuel.html b/doxygen/class_cammi_fuel.html index 2a6aad9c5..1c90514fe 100644 --- a/doxygen/class_cammi_fuel.html +++ b/doxygen/class_cammi_fuel.html @@ -412,7 +412,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_moderator-members.html b/doxygen/class_cammi_moderator-members.html index 341379a17..1ec8f753a 100644 --- a/doxygen/class_cammi_moderator-members.html +++ b/doxygen/class_cammi_moderator-members.html @@ -169,7 +169,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_moderator.html b/doxygen/class_cammi_moderator.html index edcaa7633..fa21de4fa 100644 --- a/doxygen/class_cammi_moderator.html +++ b/doxygen/class_cammi_moderator.html @@ -388,7 +388,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_conservative_advection_no_b_c_b_c-members.html b/doxygen/class_conservative_advection_no_b_c_b_c-members.html index 6fb68af93..d40977002 100644 --- a/doxygen/class_conservative_advection_no_b_c_b_c-members.html +++ b/doxygen/class_conservative_advection_no_b_c_b_c-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_conservative_advection_no_b_c_b_c.html b/doxygen/class_conservative_advection_no_b_c_b_c.html index 38db0a924..4ef22ad25 100644 --- a/doxygen/class_conservative_advection_no_b_c_b_c.html +++ b/doxygen/class_conservative_advection_no_b_c_b_c.html @@ -240,7 +240,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_constant_difference_aux-members.html b/doxygen/class_constant_difference_aux-members.html index 8910c5bff..102673f21 100644 --- a/doxygen/class_constant_difference_aux-members.html +++ b/doxygen/class_constant_difference_aux-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_constant_difference_aux.html b/doxygen/class_constant_difference_aux.html index d201eb0cc..726fe799a 100644 --- a/doxygen/class_constant_difference_aux.html +++ b/doxygen/class_constant_difference_aux.html @@ -239,7 +239,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_convective_heat_exchanger-members.html b/doxygen/class_convective_heat_exchanger-members.html index c1b1fd4b6..86a085003 100644 --- a/doxygen/class_convective_heat_exchanger-members.html +++ b/doxygen/class_convective_heat_exchanger-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_convective_heat_exchanger.html b/doxygen/class_convective_heat_exchanger.html index ac33f524c..ec8768aa9 100644 --- a/doxygen/class_convective_heat_exchanger.html +++ b/doxygen/class_convective_heat_exchanger.html @@ -264,7 +264,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_fission_kernel-members.html b/doxygen/class_coupled_fission_kernel-members.html index ba48e279f..fb188670f 100644 --- a/doxygen/class_coupled_fission_kernel-members.html +++ b/doxygen/class_coupled_fission_kernel-members.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_fission_kernel.html b/doxygen/class_coupled_fission_kernel.html index f8398c149..6fe1e0087 100644 --- a/doxygen/class_coupled_fission_kernel.html +++ b/doxygen/class_coupled_fission_kernel.html @@ -654,7 +654,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_outflow_b_c-members.html b/doxygen/class_coupled_outflow_b_c-members.html index 163cb6b2c..69be3d09d 100644 --- a/doxygen/class_coupled_outflow_b_c-members.html +++ b/doxygen/class_coupled_outflow_b_c-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_outflow_b_c.html b/doxygen/class_coupled_outflow_b_c.html index 8c0b9e90a..58ec514cc 100644 --- a/doxygen/class_coupled_outflow_b_c.html +++ b/doxygen/class_coupled_outflow_b_c.html @@ -213,7 +213,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_scalar_advection-members.html b/doxygen/class_coupled_scalar_advection-members.html index 238e38a90..e62194d87 100644 --- a/doxygen/class_coupled_scalar_advection-members.html +++ b/doxygen/class_coupled_scalar_advection-members.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_scalar_advection.html b/doxygen/class_coupled_scalar_advection.html index 27215a0b6..d9d13d1d6 100644 --- a/doxygen/class_coupled_scalar_advection.html +++ b/doxygen/class_coupled_scalar_advection.html @@ -537,7 +537,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_scalar_advection_no_b_c_b_c-members.html b/doxygen/class_coupled_scalar_advection_no_b_c_b_c-members.html index 52cc7d2e0..9ad74743b 100644 --- a/doxygen/class_coupled_scalar_advection_no_b_c_b_c-members.html +++ b/doxygen/class_coupled_scalar_advection_no_b_c_b_c-members.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_scalar_advection_no_b_c_b_c.html b/doxygen/class_coupled_scalar_advection_no_b_c_b_c.html index 1e042d6a9..f8e426a5e 100644 --- a/doxygen/class_coupled_scalar_advection_no_b_c_b_c.html +++ b/doxygen/class_coupled_scalar_advection_no_b_c_b_c.html @@ -537,7 +537,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_d_g_turbulent_diffusion-members.html b/doxygen/class_d_g_turbulent_diffusion-members.html index d609b6914..c15c37b49 100644 --- a/doxygen/class_d_g_turbulent_diffusion-members.html +++ b/doxygen/class_d_g_turbulent_diffusion-members.html @@ -100,7 +100,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_d_g_turbulent_diffusion.html b/doxygen/class_d_g_turbulent_diffusion.html index 6366b5546..848ee8875 100644 --- a/doxygen/class_d_g_turbulent_diffusion.html +++ b/doxygen/class_d_g_turbulent_diffusion.html @@ -498,7 +498,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_decay_heat_source-members.html b/doxygen/class_decay_heat_source-members.html index 9d03b658e..83de15cd4 100644 --- a/doxygen/class_decay_heat_source-members.html +++ b/doxygen/class_decay_heat_source-members.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_decay_heat_source.html b/doxygen/class_decay_heat_source.html index a35d66da8..d043dd270 100644 --- a/doxygen/class_decay_heat_source.html +++ b/doxygen/class_decay_heat_source.html @@ -364,7 +364,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_delayed_neutron_source-members.html b/doxygen/class_delayed_neutron_source-members.html index 2ce3332b5..325a0ee0f 100644 --- a/doxygen/class_delayed_neutron_source-members.html +++ b/doxygen/class_delayed_neutron_source-members.html @@ -106,7 +106,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_delayed_neutron_source.html b/doxygen/class_delayed_neutron_source.html index d134fa31c..d376e11c7 100644 --- a/doxygen/class_delayed_neutron_source.html +++ b/doxygen/class_delayed_neutron_source.html @@ -484,7 +484,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_diffusion_no_b_c_b_c-members.html b/doxygen/class_diffusion_no_b_c_b_c-members.html index d435d66f2..a85e91ac3 100644 --- a/doxygen/class_diffusion_no_b_c_b_c-members.html +++ b/doxygen/class_diffusion_no_b_c_b_c-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_diffusion_no_b_c_b_c.html b/doxygen/class_diffusion_no_b_c_b_c.html index c41b82774..9a486cdda 100644 --- a/doxygen/class_diffusion_no_b_c_b_c.html +++ b/doxygen/class_diffusion_no_b_c_b_c.html @@ -213,7 +213,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_dirac_h_x-members.html b/doxygen/class_dirac_h_x-members.html index 8cabdcc32..52d2fde5b 100644 --- a/doxygen/class_dirac_h_x-members.html +++ b/doxygen/class_dirac_h_x-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_dirac_h_x.html b/doxygen/class_dirac_h_x.html index 77c39ba12..a08b99c96 100644 --- a/doxygen/class_dirac_h_x.html +++ b/doxygen/class_dirac_h_x.html @@ -263,7 +263,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_div_free_coupled_scalar_advection-members.html b/doxygen/class_div_free_coupled_scalar_advection-members.html index b2bf2cbb3..e4aeca1f8 100644 --- a/doxygen/class_div_free_coupled_scalar_advection-members.html +++ b/doxygen/class_div_free_coupled_scalar_advection-members.html @@ -108,7 +108,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_div_free_coupled_scalar_advection.html b/doxygen/class_div_free_coupled_scalar_advection.html index 2f95ddcc8..c18de0506 100644 --- a/doxygen/class_div_free_coupled_scalar_advection.html +++ b/doxygen/class_div_free_coupled_scalar_advection.html @@ -537,7 +537,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_division_postprocessor-members.html b/doxygen/class_division_postprocessor-members.html index a08c37508..896e5e106 100644 --- a/doxygen/class_division_postprocessor-members.html +++ b/doxygen/class_division_postprocessor-members.html @@ -88,7 +88,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_division_postprocessor.html b/doxygen/class_division_postprocessor.html index 26e3daced..d5330661d 100644 --- a/doxygen/class_division_postprocessor.html +++ b/doxygen/class_division_postprocessor.html @@ -183,7 +183,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_element_l2_diff-members.html b/doxygen/class_element_l2_diff-members.html index e48abac51..99c7c472c 100644 --- a/doxygen/class_element_l2_diff-members.html +++ b/doxygen/class_element_l2_diff-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_element_l2_diff.html b/doxygen/class_element_l2_diff.html index 82775fda3..ef2d2977e 100644 --- a/doxygen/class_element_l2_diff.html +++ b/doxygen/class_element_l2_diff.html @@ -240,7 +240,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_heat_postprocessor-members.html b/doxygen/class_elm_integ_tot_fiss_heat_postprocessor-members.html index 3744ac7ea..8921924c4 100644 --- a/doxygen/class_elm_integ_tot_fiss_heat_postprocessor-members.html +++ b/doxygen/class_elm_integ_tot_fiss_heat_postprocessor-members.html @@ -103,7 +103,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_heat_postprocessor.html b/doxygen/class_elm_integ_tot_fiss_heat_postprocessor.html index a79902b13..885ddc8ed 100644 --- a/doxygen/class_elm_integ_tot_fiss_heat_postprocessor.html +++ b/doxygen/class_elm_integ_tot_fiss_heat_postprocessor.html @@ -260,7 +260,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_nts_postprocessor-members.html b/doxygen/class_elm_integ_tot_fiss_nts_postprocessor-members.html index d3ac66ee3..1a0e356b1 100644 --- a/doxygen/class_elm_integ_tot_fiss_nts_postprocessor-members.html +++ b/doxygen/class_elm_integ_tot_fiss_nts_postprocessor-members.html @@ -96,7 +96,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_nts_postprocessor.html b/doxygen/class_elm_integ_tot_fiss_nts_postprocessor.html index 6439a5b09..e0c26b5b9 100644 --- a/doxygen/class_elm_integ_tot_fiss_nts_postprocessor.html +++ b/doxygen/class_elm_integ_tot_fiss_nts_postprocessor.html @@ -383,7 +383,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_postprocessor-members.html b/doxygen/class_elm_integ_tot_fiss_postprocessor-members.html index 46de831e6..f907b7b5e 100644 --- a/doxygen/class_elm_integ_tot_fiss_postprocessor-members.html +++ b/doxygen/class_elm_integ_tot_fiss_postprocessor-members.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_elm_integ_tot_fiss_postprocessor.html b/doxygen/class_elm_integ_tot_fiss_postprocessor.html index 94cab6fac..f514b2863 100644 --- a/doxygen/class_elm_integ_tot_fiss_postprocessor.html +++ b/doxygen/class_elm_integ_tot_fiss_postprocessor.html @@ -363,7 +363,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source-members.html b/doxygen/class_fission_heat_source-members.html index 0ee332092..3c9cc2d9e 100644 --- a/doxygen/class_fission_heat_source-members.html +++ b/doxygen/class_fission_heat_source-members.html @@ -99,7 +99,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source.html b/doxygen/class_fission_heat_source.html index 03a50e3ab..d1bbc548e 100644 --- a/doxygen/class_fission_heat_source.html +++ b/doxygen/class_fission_heat_source.html @@ -462,7 +462,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source_aux-members.html b/doxygen/class_fission_heat_source_aux-members.html index 8ff48db39..0245fcdc8 100644 --- a/doxygen/class_fission_heat_source_aux-members.html +++ b/doxygen/class_fission_heat_source_aux-members.html @@ -95,7 +95,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source_aux.html b/doxygen/class_fission_heat_source_aux.html index ac591720b..8c7eaf0b9 100644 --- a/doxygen/class_fission_heat_source_aux.html +++ b/doxygen/class_fission_heat_source_aux.html @@ -364,7 +364,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source_transient_aux-members.html b/doxygen/class_fission_heat_source_transient_aux-members.html index fbd18a53b..9fa86730f 100644 --- a/doxygen/class_fission_heat_source_transient_aux-members.html +++ b/doxygen/class_fission_heat_source_transient_aux-members.html @@ -93,7 +93,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source_transient_aux.html b/doxygen/class_fission_heat_source_transient_aux.html index 99c107a93..d7f4ba1d1 100644 --- a/doxygen/class_fission_heat_source_transient_aux.html +++ b/doxygen/class_fission_heat_source_transient_aux.html @@ -311,7 +311,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_gamma_heat_source-members.html b/doxygen/class_gamma_heat_source-members.html index cf5174df9..8d7a099cd 100644 --- a/doxygen/class_gamma_heat_source-members.html +++ b/doxygen/class_gamma_heat_source-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_gamma_heat_source.html b/doxygen/class_gamma_heat_source.html index de289503d..b5c4359dd 100644 --- a/doxygen/class_gamma_heat_source.html +++ b/doxygen/class_gamma_heat_source.html @@ -264,7 +264,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_generic_moltres_material-members.html b/doxygen/class_generic_moltres_material-members.html index d144df913..1f9838d97 100644 --- a/doxygen/class_generic_moltres_material-members.html +++ b/doxygen/class_generic_moltres_material-members.html @@ -167,7 +167,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_generic_moltres_material.html b/doxygen/class_generic_moltres_material.html index 8a2a3ed52..406f19733 100644 --- a/doxygen/class_generic_moltres_material.html +++ b/doxygen/class_generic_moltres_material.html @@ -698,7 +698,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_graphite_two_grp_x_s_function_material-members.html b/doxygen/class_graphite_two_grp_x_s_function_material-members.html index 7152f4bdf..986718e31 100644 --- a/doxygen/class_graphite_two_grp_x_s_function_material-members.html +++ b/doxygen/class_graphite_two_grp_x_s_function_material-members.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_graphite_two_grp_x_s_function_material.html b/doxygen/class_graphite_two_grp_x_s_function_material.html index ec96ac390..34654b19b 100644 --- a/doxygen/class_graphite_two_grp_x_s_function_material.html +++ b/doxygen/class_graphite_two_grp_x_s_function_material.html @@ -789,7 +789,7 @@

-Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_group_diffusion-members.html b/doxygen/class_group_diffusion-members.html index e09106fef..1a04e41ff 100644 --- a/doxygen/class_group_diffusion-members.html +++ b/doxygen/class_group_diffusion-members.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_group_diffusion.html b/doxygen/class_group_diffusion.html index 318a78702..4b89f763f 100644 --- a/doxygen/class_group_diffusion.html +++ b/doxygen/class_group_diffusion.html @@ -364,7 +364,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_decay-members.html b/doxygen/class_heat_precursor_decay-members.html index cf2d480ef..a36137af3 100644 --- a/doxygen/class_heat_precursor_decay-members.html +++ b/doxygen/class_heat_precursor_decay-members.html @@ -98,7 +98,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_decay.html b/doxygen/class_heat_precursor_decay.html index 42da51971..94e19b522 100644 --- a/doxygen/class_heat_precursor_decay.html +++ b/doxygen/class_heat_precursor_decay.html @@ -290,7 +290,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_source-members.html b/doxygen/class_heat_precursor_source-members.html index c29c36391..8b216b271 100644 --- a/doxygen/class_heat_precursor_source-members.html +++ b/doxygen/class_heat_precursor_source-members.html @@ -110,7 +110,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_source.html b/doxygen/class_heat_precursor_source.html index 10bc813e1..2758a49df 100644 --- a/doxygen/class_heat_precursor_source.html +++ b/doxygen/class_heat_precursor_source.html @@ -582,7 +582,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion-members.html b/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion-members.html index cb38aa86b..4f8b36e48 100644 --- a/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion-members.html +++ b/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion-members.html @@ -92,7 +92,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion.html b/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion.html index 4221c252c..73da55998 100644 --- a/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion.html +++ b/doxygen/class_i_n_s_a_d_energy_turbulent_diffusion.html @@ -287,7 +287,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c-members.html b/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c-members.html index 7bbc05ddb..59c41c1af 100644 --- a/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c-members.html +++ b/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c.html b/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c.html index 0981a7e00..e56fe2240 100644 --- a/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c.html +++ b/doxygen/class_i_n_s_a_d_mass_p_s_p_g_b_c.html @@ -263,7 +263,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c-members.html b/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c-members.html index 0ae28050a..b3e09af44 100644 --- a/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c-members.html +++ b/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c-members.html @@ -95,7 +95,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c.html b/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c.html index f51cc70e6..267fc6890 100644 --- a/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c.html +++ b/doxygen/class_i_n_s_a_d_momentum_s_u_p_g_b_c.html @@ -371,7 +371,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c-members.html b/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c-members.html index 5a040543d..0c557e45d 100644 --- a/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c-members.html +++ b/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c.html b/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c.html index 005bb007d..538dc6e15 100644 --- a/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c.html +++ b/doxygen/class_i_n_s_a_d_momentum_turbulent_no_b_c_b_c.html @@ -215,7 +215,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous-members.html b/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous-members.html index a8be38826..8d8a187d8 100644 --- a/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous-members.html +++ b/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous.html b/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous.html index 2929416cd..3c2185771 100644 --- a/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous.html +++ b/doxygen/class_i_n_s_a_d_momentum_turbulent_viscous.html @@ -271,7 +271,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_boussinesq_body_force-members.html b/doxygen/class_i_n_s_boussinesq_body_force-members.html index 707b0a269..4979e5623 100644 --- a/doxygen/class_i_n_s_boussinesq_body_force-members.html +++ b/doxygen/class_i_n_s_boussinesq_body_force-members.html @@ -98,7 +98,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_i_n_s_boussinesq_body_force.html b/doxygen/class_i_n_s_boussinesq_body_force.html index 9da2e9c88..37fac8fe9 100644 --- a/doxygen/class_i_n_s_boussinesq_body_force.html +++ b/doxygen/class_i_n_s_boussinesq_body_force.html @@ -441,7 +441,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_in_scatter-members.html b/doxygen/class_in_scatter-members.html index bdac3e9e6..cebb64ea3 100644 --- a/doxygen/class_in_scatter-members.html +++ b/doxygen/class_in_scatter-members.html @@ -105,7 +105,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_in_scatter.html b/doxygen/class_in_scatter.html index 526cdfb56..0b03fe7a7 100644 --- a/doxygen/class_in_scatter.html +++ b/doxygen/class_in_scatter.html @@ -460,7 +460,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_integral_new_variable_postprocessor-members.html b/doxygen/class_integral_new_variable_postprocessor-members.html index 23f923252..4584392b2 100644 --- a/doxygen/class_integral_new_variable_postprocessor-members.html +++ b/doxygen/class_integral_new_variable_postprocessor-members.html @@ -98,7 +98,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_integral_new_variable_postprocessor.html b/doxygen/class_integral_new_variable_postprocessor.html index 9e8a59abb..73610134b 100644 --- a/doxygen/class_integral_new_variable_postprocessor.html +++ b/doxygen/class_integral_new_variable_postprocessor.html @@ -297,7 +297,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_integral_old_variable_postprocessor-members.html b/doxygen/class_integral_old_variable_postprocessor-members.html index 8bbab9e57..0331cfef7 100644 --- a/doxygen/class_integral_old_variable_postprocessor-members.html +++ b/doxygen/class_integral_old_variable_postprocessor-members.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_integral_old_variable_postprocessor.html b/doxygen/class_integral_old_variable_postprocessor.html index 68f329be9..ab40a2745 100644 --- a/doxygen/class_integral_old_variable_postprocessor.html +++ b/doxygen/class_integral_old_variable_postprocessor.html @@ -270,7 +270,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_limit_k-members.html b/doxygen/class_limit_k-members.html index 2c2da4817..e49275508 100644 --- a/doxygen/class_limit_k-members.html +++ b/doxygen/class_limit_k-members.html @@ -94,7 +94,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_limit_k.html b/doxygen/class_limit_k.html index b6be28dbb..a6f6f4e20 100644 --- a/doxygen/class_limit_k.html +++ b/doxygen/class_limit_k.html @@ -335,7 +335,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_lin_log_penalty_dirichlet_b_c-members.html b/doxygen/class_lin_log_penalty_dirichlet_b_c-members.html index c9063bb9a..3de74cbf0 100644 --- a/doxygen/class_lin_log_penalty_dirichlet_b_c-members.html +++ b/doxygen/class_lin_log_penalty_dirichlet_b_c-members.html @@ -96,7 +96,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_lin_log_penalty_dirichlet_b_c.html b/doxygen/class_lin_log_penalty_dirichlet_b_c.html index 9ac1bc28f..2e674b9e4 100644 --- a/doxygen/class_lin_log_penalty_dirichlet_b_c.html +++ b/doxygen/class_lin_log_penalty_dirichlet_b_c.html @@ -235,7 +235,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_mat_diffusion_aux-members.html b/doxygen/class_mat_diffusion_aux-members.html index 1ab7e4d36..5f2951c23 100644 --- a/doxygen/class_mat_diffusion_aux-members.html +++ b/doxygen/class_mat_diffusion_aux-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_mat_diffusion_aux.html b/doxygen/class_mat_diffusion_aux.html index 96f299e6c..e35418fda 100644 --- a/doxygen/class_mat_diffusion_aux.html +++ b/doxygen/class_mat_diffusion_aux.html @@ -268,7 +268,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_mat_diffusion_flux_b_c-members.html b/doxygen/class_mat_diffusion_flux_b_c-members.html index 008a3cd26..f6f05a3fb 100644 --- a/doxygen/class_mat_diffusion_flux_b_c-members.html +++ b/doxygen/class_mat_diffusion_flux_b_c-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_mat_diffusion_flux_b_c.html b/doxygen/class_mat_diffusion_flux_b_c.html index 802583728..897508a5c 100644 --- a/doxygen/class_mat_diffusion_flux_b_c.html +++ b/doxygen/class_mat_diffusion_flux_b_c.html @@ -240,7 +240,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moderator_heat_source_transient_aux-members.html b/doxygen/class_moderator_heat_source_transient_aux-members.html index 6e904b240..80f2e5912 100644 --- a/doxygen/class_moderator_heat_source_transient_aux-members.html +++ b/doxygen/class_moderator_heat_source_transient_aux-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moderator_heat_source_transient_aux.html b/doxygen/class_moderator_heat_source_transient_aux.html index 6558a2c4f..dda642b86 100644 --- a/doxygen/class_moderator_heat_source_transient_aux.html +++ b/doxygen/class_moderator_heat_source_transient_aux.html @@ -240,7 +240,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_app-members.html b/doxygen/class_moltres_app-members.html index 4d69ac414..3ec6a7aa6 100644 --- a/doxygen/class_moltres_app-members.html +++ b/doxygen/class_moltres_app-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_app.html b/doxygen/class_moltres_app.html index a43c43e09..a28aa1e53 100644 --- a/doxygen/class_moltres_app.html +++ b/doxygen/class_moltres_app.html @@ -251,7 +251,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_json_material-members.html b/doxygen/class_moltres_json_material-members.html index bd14dbdda..1e58dc153 100644 --- a/doxygen/class_moltres_json_material-members.html +++ b/doxygen/class_moltres_json_material-members.html @@ -156,7 +156,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_json_material.html b/doxygen/class_moltres_json_material.html index e212df14e..bd56f9b14 100644 --- a/doxygen/class_moltres_json_material.html +++ b/doxygen/class_moltres_json_material.html @@ -402,7 +402,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_msre_fuel_two_grp_x_s_function_material-members.html b/doxygen/class_msre_fuel_two_grp_x_s_function_material-members.html index 89d0ad9bd..ad160c17f 100644 --- a/doxygen/class_msre_fuel_two_grp_x_s_function_material-members.html +++ b/doxygen/class_msre_fuel_two_grp_x_s_function_material-members.html @@ -114,7 +114,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_msre_fuel_two_grp_x_s_function_material.html b/doxygen/class_msre_fuel_two_grp_x_s_function_material.html index 76a26a03b..fa14e1c81 100644 --- a/doxygen/class_msre_fuel_two_grp_x_s_function_material.html +++ b/doxygen/class_msre_fuel_two_grp_x_s_function_material.html @@ -813,7 +813,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_neutron_leakage-members.html b/doxygen/class_neutron_leakage-members.html index 58a6b6b41..49b4e2cde 100644 --- a/doxygen/class_neutron_leakage-members.html +++ b/doxygen/class_neutron_leakage-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_neutron_leakage.html b/doxygen/class_neutron_leakage.html index 697e96391..95e871620 100644 --- a/doxygen/class_neutron_leakage.html +++ b/doxygen/class_neutron_leakage.html @@ -239,7 +239,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_action-members.html b/doxygen/class_nt_action-members.html index 0f43e0126..13d7d688c 100644 --- a/doxygen/class_nt_action-members.html +++ b/doxygen/class_nt_action-members.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_action.html b/doxygen/class_nt_action.html index 24178db9c..f9456493a 100644 --- a/doxygen/class_nt_action.html +++ b/doxygen/class_nt_action.html @@ -452,7 +452,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_time_derivative-members.html b/doxygen/class_nt_time_derivative-members.html index d8898f8cb..51e6b66f5 100644 --- a/doxygen/class_nt_time_derivative-members.html +++ b/doxygen/class_nt_time_derivative-members.html @@ -104,7 +104,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_time_derivative.html b/doxygen/class_nt_time_derivative.html index 1a212e629..e1adeb265 100644 --- a/doxygen/class_nt_time_derivative.html +++ b/doxygen/class_nt_time_derivative.html @@ -379,7 +379,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nuclear_material-members.html b/doxygen/class_nuclear_material-members.html index 87ce15785..77a754a5f 100644 --- a/doxygen/class_nuclear_material-members.html +++ b/doxygen/class_nuclear_material-members.html @@ -151,7 +151,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nuclear_material.html b/doxygen/class_nuclear_material.html index 8380c0812..a3d594948 100644 --- a/doxygen/class_nuclear_material.html +++ b/doxygen/class_nuclear_material.html @@ -1602,7 +1602,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nusselt-members.html b/doxygen/class_nusselt-members.html index 279a8b1ee..6eb6779a3 100644 --- a/doxygen/class_nusselt-members.html +++ b/doxygen/class_nusselt-members.html @@ -92,7 +92,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nusselt.html b/doxygen/class_nusselt.html index bc899acc6..1219cb994 100644 --- a/doxygen/class_nusselt.html +++ b/doxygen/class_nusselt.html @@ -285,7 +285,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_postprocessor_coupled_inflow_b_c-members.html b/doxygen/class_postprocessor_coupled_inflow_b_c-members.html index f422a00e8..89e0b4c38 100644 --- a/doxygen/class_postprocessor_coupled_inflow_b_c-members.html +++ b/doxygen/class_postprocessor_coupled_inflow_b_c-members.html @@ -92,7 +92,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_postprocessor_coupled_inflow_b_c.html b/doxygen/class_postprocessor_coupled_inflow_b_c.html index 4d1ce7b30..5be6cf894 100644 --- a/doxygen/class_postprocessor_coupled_inflow_b_c.html +++ b/doxygen/class_postprocessor_coupled_inflow_b_c.html @@ -290,7 +290,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_action-members.html b/doxygen/class_precursor_action-members.html index 839a6fcf5..49a0ca5b6 100644 --- a/doxygen/class_precursor_action-members.html +++ b/doxygen/class_precursor_action-members.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_action.html b/doxygen/class_precursor_action.html index 9cfa639dc..c3307c7b0 100644 --- a/doxygen/class_precursor_action.html +++ b/doxygen/class_precursor_action.html @@ -814,7 +814,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_decay-members.html b/doxygen/class_precursor_decay-members.html index 70f80c415..f3f66a158 100644 --- a/doxygen/class_precursor_decay-members.html +++ b/doxygen/class_precursor_decay-members.html @@ -103,7 +103,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_decay.html b/doxygen/class_precursor_decay.html index 51fe7501e..ad79bea0d 100644 --- a/doxygen/class_precursor_decay.html +++ b/doxygen/class_precursor_decay.html @@ -412,7 +412,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_source-members.html b/doxygen/class_precursor_source-members.html index 1de70351a..e94be3cbf 100644 --- a/doxygen/class_precursor_source-members.html +++ b/doxygen/class_precursor_source-members.html @@ -109,7 +109,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_source.html b/doxygen/class_precursor_source.html index fea2648b0..b8be90ea5 100644 --- a/doxygen/class_precursor_source.html +++ b/doxygen/class_precursor_source.html @@ -556,7 +556,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_rodded_material-members.html b/doxygen/class_rodded_material-members.html index 8f8daee59..03f168f84 100644 --- a/doxygen/class_rodded_material-members.html +++ b/doxygen/class_rodded_material-members.html @@ -173,7 +173,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_rodded_material.html b/doxygen/class_rodded_material.html index add432799..76242e24d 100644 --- a/doxygen/class_rodded_material.html +++ b/doxygen/class_rodded_material.html @@ -505,7 +505,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_tau_material_templ-members.html b/doxygen/class_s_a_tau_material_templ-members.html index ac487feb5..6afe712be 100644 --- a/doxygen/class_s_a_tau_material_templ-members.html +++ b/doxygen/class_s_a_tau_material_templ-members.html @@ -114,7 +114,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_tau_material_templ.html b/doxygen/class_s_a_tau_material_templ.html index 42b0e2f38..f9290aaa5 100644 --- a/doxygen/class_s_a_tau_material_templ.html +++ b/doxygen/class_s_a_tau_material_templ.html @@ -875,7 +875,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_tau_stabilized3_eqn-members.html b/doxygen/class_s_a_tau_stabilized3_eqn-members.html index ecc455611..adc60aec7 100644 --- a/doxygen/class_s_a_tau_stabilized3_eqn-members.html +++ b/doxygen/class_s_a_tau_stabilized3_eqn-members.html @@ -116,7 +116,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_tau_stabilized3_eqn.html b/doxygen/class_s_a_tau_stabilized3_eqn.html index 33924b814..c80fdd9d9 100644 --- a/doxygen/class_s_a_tau_stabilized3_eqn.html +++ b/doxygen/class_s_a_tau_stabilized3_eqn.html @@ -274,7 +274,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_time_derivative-members.html b/doxygen/class_s_a_time_derivative-members.html index 8603b8bd2..1c64b20ca 100644 --- a/doxygen/class_s_a_time_derivative-members.html +++ b/doxygen/class_s_a_time_derivative-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_time_derivative.html b/doxygen/class_s_a_time_derivative.html index 37593d052..b135c5aee 100644 --- a/doxygen/class_s_a_time_derivative.html +++ b/doxygen/class_s_a_time_derivative.html @@ -215,7 +215,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity-members.html b/doxygen/class_s_a_turbulent_viscosity-members.html index 324c772fd..228e48249 100644 --- a/doxygen/class_s_a_turbulent_viscosity-members.html +++ b/doxygen/class_s_a_turbulent_viscosity-members.html @@ -93,7 +93,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity.html b/doxygen/class_s_a_turbulent_viscosity.html index acd0f2fd9..e12a51449 100644 --- a/doxygen/class_s_a_turbulent_viscosity.html +++ b/doxygen/class_s_a_turbulent_viscosity.html @@ -311,7 +311,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_aux-members.html b/doxygen/class_s_a_turbulent_viscosity_aux-members.html index 92bce371d..6c959795d 100644 --- a/doxygen/class_s_a_turbulent_viscosity_aux-members.html +++ b/doxygen/class_s_a_turbulent_viscosity_aux-members.html @@ -90,7 +90,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_aux.html b/doxygen/class_s_a_turbulent_viscosity_aux.html index fdc1f7279..8cdeb3d4f 100644 --- a/doxygen/class_s_a_turbulent_viscosity_aux.html +++ b/doxygen/class_s_a_turbulent_viscosity_aux.html @@ -237,7 +237,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c-members.html b/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c-members.html index 1730c9ca9..1dc0419da 100644 --- a/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c-members.html +++ b/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c.html b/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c.html index 4e6cae68d..924c86dab 100644 --- a/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c.html +++ b/doxygen/class_s_a_turbulent_viscosity_no_b_c_b_c.html @@ -215,7 +215,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g-members.html b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g-members.html index 6c0dc591d..2f6b777c7 100644 --- a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g-members.html +++ b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g.html b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g.html index 25e724afe..aec7543c3 100644 --- a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g.html +++ b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g.html @@ -215,7 +215,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c-members.html b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c-members.html index ae8fd76f2..79290f887 100644 --- a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c-members.html +++ b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c-members.html @@ -95,7 +95,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c.html b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c.html index 955894108..bd703bb62 100644 --- a/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c.html +++ b/doxygen/class_s_a_turbulent_viscosity_s_u_p_g_b_c.html @@ -371,7 +371,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_advection_art_diff-members.html b/doxygen/class_scalar_advection_art_diff-members.html index 8a9b88bab..2b3f64e01 100644 --- a/doxygen/class_scalar_advection_art_diff-members.html +++ b/doxygen/class_scalar_advection_art_diff-members.html @@ -112,7 +112,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_advection_art_diff.html b/doxygen/class_scalar_advection_art_diff.html index 834a71eae..e76cb1a28 100644 --- a/doxygen/class_scalar_advection_art_diff.html +++ b/doxygen/class_scalar_advection_art_diff.html @@ -652,7 +652,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_advection_art_diff_no_b_c_b_c-members.html b/doxygen/class_scalar_advection_art_diff_no_b_c_b_c-members.html index 88bc79061..c0abd671b 100644 --- a/doxygen/class_scalar_advection_art_diff_no_b_c_b_c-members.html +++ b/doxygen/class_scalar_advection_art_diff_no_b_c_b_c-members.html @@ -110,7 +110,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_advection_art_diff_no_b_c_b_c.html b/doxygen/class_scalar_advection_art_diff_no_b_c_b_c.html index 27ee41cad..a839ae587 100644 --- a/doxygen/class_scalar_advection_art_diff_no_b_c_b_c.html +++ b/doxygen/class_scalar_advection_art_diff_no_b_c_b_c.html @@ -585,7 +585,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_transport_base-members.html b/doxygen/class_scalar_transport_base-members.html index 8bad80584..72bd1fda9 100644 --- a/doxygen/class_scalar_transport_base-members.html +++ b/doxygen/class_scalar_transport_base-members.html @@ -93,7 +93,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_transport_base.html b/doxygen/class_scalar_transport_base.html index 3e956d690..d0f26c0b8 100644 --- a/doxygen/class_scalar_transport_base.html +++ b/doxygen/class_scalar_transport_base.html @@ -473,7 +473,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_transport_time_derivative-members.html b/doxygen/class_scalar_transport_time_derivative-members.html index 79e540885..2110b8725 100644 --- a/doxygen/class_scalar_transport_time_derivative-members.html +++ b/doxygen/class_scalar_transport_time_derivative-members.html @@ -98,7 +98,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_transport_time_derivative.html b/doxygen/class_scalar_transport_time_derivative.html index 3fc5800e9..f77302a0e 100644 --- a/doxygen/class_scalar_transport_time_derivative.html +++ b/doxygen/class_scalar_transport_time_derivative.html @@ -292,7 +292,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_side_weighted_integral_postprocessor-members.html b/doxygen/class_side_weighted_integral_postprocessor-members.html index 1e8843d38..adeb864da 100644 --- a/doxygen/class_side_weighted_integral_postprocessor-members.html +++ b/doxygen/class_side_weighted_integral_postprocessor-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_side_weighted_integral_postprocessor.html b/doxygen/class_side_weighted_integral_postprocessor.html index 83a56b316..a968e4ffb 100644 --- a/doxygen/class_side_weighted_integral_postprocessor.html +++ b/doxygen/class_side_weighted_integral_postprocessor.html @@ -215,7 +215,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_sigma_r-members.html b/doxygen/class_sigma_r-members.html index 8e646c8d9..f42d2749c 100644 --- a/doxygen/class_sigma_r-members.html +++ b/doxygen/class_sigma_r-members.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_sigma_r.html b/doxygen/class_sigma_r.html index 8691815b7..37be0eb9d 100644 --- a/doxygen/class_sigma_r.html +++ b/doxygen/class_sigma_r.html @@ -364,7 +364,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_total_neutron_leakage-members.html b/doxygen/class_total_neutron_leakage-members.html index de2074916..dd4fd77f1 100644 --- a/doxygen/class_total_neutron_leakage-members.html +++ b/doxygen/class_total_neutron_leakage-members.html @@ -100,7 +100,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_total_neutron_leakage.html b/doxygen/class_total_neutron_leakage.html index bf287c004..7ad0fbdb1 100644 --- a/doxygen/class_total_neutron_leakage.html +++ b/doxygen/class_total_neutron_leakage.html @@ -335,7 +335,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_transient_fission_heat_source-members.html b/doxygen/class_transient_fission_heat_source-members.html index cbf5be36f..0d2eec086 100644 --- a/doxygen/class_transient_fission_heat_source-members.html +++ b/doxygen/class_transient_fission_heat_source-members.html @@ -111,7 +111,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_transient_fission_heat_source.html b/doxygen/class_transient_fission_heat_source.html index 7efc5ca48..3124b8a42 100644 --- a/doxygen/class_transient_fission_heat_source.html +++ b/doxygen/class_transient_fission_heat_source.html @@ -606,7 +606,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_turbulent_stress_aux-members.html b/doxygen/class_turbulent_stress_aux-members.html index 79a64bc73..7c1213f3a 100644 --- a/doxygen/class_turbulent_stress_aux-members.html +++ b/doxygen/class_turbulent_stress_aux-members.html @@ -92,7 +92,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_turbulent_stress_aux.html b/doxygen/class_turbulent_stress_aux.html index 6151b7286..e8a6fa5af 100644 --- a/doxygen/class_turbulent_stress_aux.html +++ b/doxygen/class_turbulent_stress_aux.html @@ -287,7 +287,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_vacuum_conc_b_c-members.html b/doxygen/class_vacuum_conc_b_c-members.html index afb5b14ec..68ee2769d 100644 --- a/doxygen/class_vacuum_conc_b_c-members.html +++ b/doxygen/class_vacuum_conc_b_c-members.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_vacuum_conc_b_c.html b/doxygen/class_vacuum_conc_b_c.html index 6b835ec6f..f32e0ebcf 100644 --- a/doxygen/class_vacuum_conc_b_c.html +++ b/doxygen/class_vacuum_conc_b_c.html @@ -270,7 +270,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_variable_not_a_moose_object_action-members.html b/doxygen/class_variable_not_a_moose_object_action-members.html index a58af0fbc..0edb246a5 100644 --- a/doxygen/class_variable_not_a_moose_object_action-members.html +++ b/doxygen/class_variable_not_a_moose_object_action-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_variable_not_a_moose_object_action.html b/doxygen/class_variable_not_a_moose_object_action.html index 3605aef56..137c18a1b 100644 --- a/doxygen/class_variable_not_a_moose_object_action.html +++ b/doxygen/class_variable_not_a_moose_object_action.html @@ -219,7 +219,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_wall_distance_aux-members.html b/doxygen/class_wall_distance_aux-members.html index 3b6287a2c..107a6f8d7 100644 --- a/doxygen/class_wall_distance_aux-members.html +++ b/doxygen/class_wall_distance_aux-members.html @@ -89,7 +89,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_wall_distance_aux.html b/doxygen/class_wall_distance_aux.html index 68f87615c..72002591f 100644 --- a/doxygen/class_wall_distance_aux.html +++ b/doxygen/class_wall_distance_aux.html @@ -213,7 +213,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_wall_shear_stress_aux-members.html b/doxygen/class_wall_shear_stress_aux-members.html index dff63c32c..0d2524d4e 100644 --- a/doxygen/class_wall_shear_stress_aux-members.html +++ b/doxygen/class_wall_shear_stress_aux-members.html @@ -91,7 +91,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_wall_shear_stress_aux.html b/doxygen/class_wall_shear_stress_aux.html index 0cf0edc1b..51912bb90 100644 --- a/doxygen/class_wall_shear_stress_aux.html +++ b/doxygen/class_wall_shear_stress_aux.html @@ -263,7 +263,7 @@

-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/classes.html b/doxygen/classes.html index cc3eeed2f..bdecd6a93 100644 --- a/doxygen/classes.html +++ b/doxygen/classes.html @@ -136,7 +136,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000001_000012.html b/doxygen/dir_000001_000012.html index 7f92f324a..71679bc2d 100644 --- a/doxygen/dir_000001_000012.html +++ b/doxygen/dir_000001_000012.html @@ -83,7 +83,7 @@

actions → include Relation

File in src/actionsIncludes file in include
NtAction.Cactions / NtAction.h
PrecursorAction.Cactions / PrecursorAction.h
VariableNotAMooseObjectAction.Cactions / VariableNotAMooseObjectAction.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000003_000012.html b/doxygen/dir_000003_000012.html index cb009f68c..7cd422340 100644 --- a/doxygen/dir_000003_000012.html +++ b/doxygen/dir_000003_000012.html @@ -83,7 +83,7 @@

auxkernels → include Relation

File in src/auxkernelsIncludes file in include
ConstantDifferenceAux.Cauxkernels / ConstantDifferenceAux.h
FissionHeatSourceAux.Cauxkernels / FissionHeatSourceAux.h
FissionHeatSourceTransientAux.Cauxkernels / FissionHeatSourceTransientAux.h
MatDiffusionAux.Cauxkernels / MatDiffusionAux.h
ModeratorHeatSourceTransientAux.Cauxkernels / ModeratorHeatSourceTransientAux.h
SATurbulentViscosityAux.Cauxkernels / SATurbulentViscosityAux.h
TurbulentStressAux.Cauxkernels / TurbulentStressAux.h
WallDistanceAux.Cauxkernels / WallDistanceAux.h
WallShearStressAux.Cauxkernels / WallShearStressAux.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000005_000012.html b/doxygen/dir_000005_000012.html index 3cbb1ade9..e754d2939 100644 --- a/doxygen/dir_000005_000012.html +++ b/doxygen/dir_000005_000012.html @@ -83,7 +83,7 @@

base → include Relation

File in src/baseIncludes file in include
MoltresApp.Cbase / MoltresApp.h
ScalarTransportBase.Cbase / ScalarTransportBase.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000006_000004.html b/doxygen/dir_000006_000004.html index e5259d0da..bd246589c 100644 --- a/doxygen/dir_000006_000004.html +++ b/doxygen/dir_000006_000004.html @@ -83,7 +83,7 @@

bcs → base Relation

File in include/bcsIncludes file in include/base
CoupledScalarAdvectionNoBCBC.hScalarTransportBase.h
LinLogPenaltyDirichletBC.hScalarTransportBase.h
ScalarAdvectionArtDiffNoBCBC.hScalarTransportBase.h
VacuumConcBC.hScalarTransportBase.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000007_000012.html b/doxygen/dir_000007_000012.html index 6e82f66b9..bd098f01a 100644 --- a/doxygen/dir_000007_000012.html +++ b/doxygen/dir_000007_000012.html @@ -83,7 +83,7 @@

bcs → include Relation

File in src/bcsIncludes file in include
ConservativeAdvectionNoBCBC.Cbcs / ConservativeAdvectionNoBCBC.h
CoupledOutflowBC.Cbcs / CoupledOutflowBC.h
CoupledScalarAdvectionNoBCBC.Cbcs / CoupledScalarAdvectionNoBCBC.h
DiffusionNoBCBC.Cbcs / DiffusionNoBCBC.h
INSADMassPSPGBC.Cbcs / INSADMassPSPGBC.h
INSADMomentumSUPGBC.Cbcs / INSADMomentumSUPGBC.h
INSADMomentumTurbulentNoBCBC.Cbcs / INSADMomentumTurbulentNoBCBC.h
LinLogPenaltyDirichletBC.Cbcs / LinLogPenaltyDirichletBC.h
MatDiffusionFluxBC.Cbcs / MatDiffusionFluxBC.h
PostprocessorCoupledInflowBC.Cbcs / PostprocessorCoupledInflowBC.h
SATurbulentViscosityNoBCBC.Cbcs / SATurbulentViscosityNoBCBC.h
SATurbulentViscositySUPGBC.Cbcs / SATurbulentViscositySUPGBC.h
ScalarAdvectionArtDiffNoBCBC.Cbcs / ScalarAdvectionArtDiffNoBCBC.h
VacuumConcBC.Cbcs / VacuumConcBC.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000009_000012.html b/doxygen/dir_000009_000012.html index 54a13d733..049faa65a 100644 --- a/doxygen/dir_000009_000012.html +++ b/doxygen/dir_000009_000012.html @@ -83,7 +83,7 @@

dgkernels → include Relation

File in src/dgkernelsIncludes file in include
DGTurbulentDiffusion.Cdgkernels / DGTurbulentDiffusion.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000011_000012.html b/doxygen/dir_000011_000012.html index cd5dfd227..c863dfc9e 100644 --- a/doxygen/dir_000011_000012.html +++ b/doxygen/dir_000011_000012.html @@ -83,7 +83,7 @@

dirackernels → include Relation

File in src/dirackernelsIncludes file in include
DiracHX.Cdirackernels / DiracHX.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000013_000004.html b/doxygen/dir_000013_000004.html index 5e9f48adb..3f1900b82 100644 --- a/doxygen/dir_000013_000004.html +++ b/doxygen/dir_000013_000004.html @@ -83,7 +83,7 @@

kernels → base Relation

File in include/kernelsIncludes file in include/base
CoupledFissionKernel.hScalarTransportBase.h
CoupledScalarAdvection.hScalarTransportBase.h
DecayHeatSource.hScalarTransportBase.h
DelayedNeutronSource.hScalarTransportBase.h
DivFreeCoupledScalarAdvection.hScalarTransportBase.h
GroupDiffusion.hScalarTransportBase.h
HeatPrecursorDecay.hScalarTransportBase.h
HeatPrecursorSource.hScalarTransportBase.h
InScatter.hScalarTransportBase.h
PrecursorDecay.hScalarTransportBase.h
PrecursorSource.hScalarTransportBase.h
ScalarAdvectionArtDiff.hScalarTransportBase.h
ScalarTransportTimeDerivative.hScalarTransportBase.h
SigmaR.hScalarTransportBase.h
TransientFissionHeatSource.hScalarTransportBase.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000014_000012.html b/doxygen/dir_000014_000012.html index 5c5a3811d..e7d635364 100644 --- a/doxygen/dir_000014_000012.html +++ b/doxygen/dir_000014_000012.html @@ -83,7 +83,7 @@

kernels → include Relation

File in src/kernelsIncludes file in include
ConvectiveHeatExchanger.Ckernels / ConvectiveHeatExchanger.h
CoupledFissionKernel.Ckernels / CoupledFissionKernel.h
CoupledScalarAdvection.Ckernels / CoupledScalarAdvection.h
DecayHeatSource.Ckernels / DecayHeatSource.h
DelayedNeutronSource.Ckernels / DelayedNeutronSource.h
DivFreeCoupledScalarAdvection.Ckernels / DivFreeCoupledScalarAdvection.h
FissionHeatSource.Ckernels / FissionHeatSource.h
GammaHeatSource.Ckernels / GammaHeatSource.h
GroupDiffusion.Ckernels / GroupDiffusion.h
HeatPrecursorDecay.Ckernels / HeatPrecursorDecay.h
HeatPrecursorSource.Ckernels / HeatPrecursorSource.h
INSADEnergyTurbulentDiffusion.Ckernels / INSADEnergyTurbulentDiffusion.h
INSADMomentumTurbulentViscous.Ckernels / INSADMomentumTurbulentViscous.h
INSBoussinesqBodyForce.Ckernels / INSBoussinesqBodyForce.h
InScatter.Ckernels / InScatter.h
NtTimeDerivative.Ckernels / NtTimeDerivative.h
PrecursorDecay.Ckernels / PrecursorDecay.h
PrecursorSource.Ckernels / PrecursorSource.h
SATimeDerivative.Ckernels / SATimeDerivative.h
SATurbulentViscosity.Ckernels / SATurbulentViscosity.h
SATurbulentViscositySUPG.Ckernels / SATurbulentViscositySUPG.h
ScalarAdvectionArtDiff.Ckernels / ScalarAdvectionArtDiff.h
ScalarTransportTimeDerivative.Ckernels / ScalarTransportTimeDerivative.h
SigmaR.Ckernels / SigmaR.h
TransientFissionHeatSource.Ckernels / TransientFissionHeatSource.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000016_000012.html b/doxygen/dir_000016_000012.html index f2737afab..feff7d961 100644 --- a/doxygen/dir_000016_000012.html +++ b/doxygen/dir_000016_000012.html @@ -83,7 +83,7 @@

materials → include Relation

File in src/materialsIncludes file in include
CammiFuel.Cmaterials / CammiFuel.h
CammiModerator.Cmaterials / CammiModerator.h
GenericMoltresMaterial.Cmaterials / GenericMoltresMaterial.h
GraphiteTwoGrpXSFunctionMaterial.Cmaterials / GraphiteTwoGrpXSFunctionMaterial.h
MoltresJsonMaterial.Cmaterials / MoltresJsonMaterial.h
MsreFuelTwoGrpXSFunctionMaterial.Cmaterials / MsreFuelTwoGrpXSFunctionMaterial.h
NuclearMaterial.Cmaterials / NuclearMaterial.h
Nusselt.Cmaterials / Nusselt.h
RoddedMaterial.Cmaterials / RoddedMaterial.h
SATauMaterial.Cmaterials / SATauMaterial.h
SATauStabilized3Eqn.Cmaterials / SATauStabilized3Eqn.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000017_000004.html b/doxygen/dir_000017_000004.html index c8af345df..4211db8a7 100644 --- a/doxygen/dir_000017_000004.html +++ b/doxygen/dir_000017_000004.html @@ -83,7 +83,7 @@

postprocessors → base Relation

File in include/postprocessorsIncludes file in include/base
ElmIntegTotFissPostprocessor.hScalarTransportBase.h
IntegralNewVariablePostprocessor.hScalarTransportBase.h
IntegralOldVariablePostprocessor.hScalarTransportBase.h
TotalNeutronLeakage.hScalarTransportBase.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000018_000012.html b/doxygen/dir_000018_000012.html index 74439a76e..10703d1c2 100644 --- a/doxygen/dir_000018_000012.html +++ b/doxygen/dir_000018_000012.html @@ -83,7 +83,7 @@

postprocessors → include Relation

File in src/postprocessorsIncludes file in include
AverageFissionHeat.Cpostprocessors / AverageFissionHeat.h
DivisionPostprocessor.Cpostprocessors / DivisionPostprocessor.h
ElementL2Diff.Cpostprocessors / ElementL2Diff.h
ElmIntegTotFissHeatPostprocessor.Cpostprocessors / ElmIntegTotFissHeatPostprocessor.h
ElmIntegTotFissNtsPostprocessor.Cpostprocessors / ElmIntegTotFissNtsPostprocessor.h
ElmIntegTotFissPostprocessor.Cpostprocessors / ElmIntegTotFissPostprocessor.h
IntegralNewVariablePostprocessor.Cpostprocessors / IntegralNewVariablePostprocessor.h
IntegralOldVariablePostprocessor.Cpostprocessors / IntegralOldVariablePostprocessor.h
LimitK.Cpostprocessors / LimitK.h
NeutronLeakage.Cpostprocessors / NeutronLeakage.h
SideWeightedIntegralPostprocessor.Cpostprocessors / SideWeightedIntegralPostprocessor.h
TotalNeutronLeakage.Cpostprocessors / TotalNeutronLeakage.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000019_000012.html b/doxygen/dir_000019_000012.html index d5c1d205e..7ce00b896 100644 --- a/doxygen/dir_000019_000012.html +++ b/doxygen/dir_000019_000012.html @@ -83,7 +83,7 @@

src → include Relation

File in srcIncludes file in include
postprocessors / AverageFissionHeat.Cpostprocessors / AverageFissionHeat.h
materials / CammiFuel.Cmaterials / CammiFuel.h
materials / CammiModerator.Cmaterials / CammiModerator.h
bcs / ConservativeAdvectionNoBCBC.Cbcs / ConservativeAdvectionNoBCBC.h
auxkernels / ConstantDifferenceAux.Cauxkernels / ConstantDifferenceAux.h
kernels / ConvectiveHeatExchanger.Ckernels / ConvectiveHeatExchanger.h
kernels / CoupledFissionKernel.Ckernels / CoupledFissionKernel.h
bcs / CoupledOutflowBC.Cbcs / CoupledOutflowBC.h
kernels / CoupledScalarAdvection.Ckernels / CoupledScalarAdvection.h
bcs / CoupledScalarAdvectionNoBCBC.Cbcs / CoupledScalarAdvectionNoBCBC.h
kernels / DecayHeatSource.Ckernels / DecayHeatSource.h
kernels / DelayedNeutronSource.Ckernels / DelayedNeutronSource.h
dgkernels / DGTurbulentDiffusion.Cdgkernels / DGTurbulentDiffusion.h
bcs / DiffusionNoBCBC.Cbcs / DiffusionNoBCBC.h
dirackernels / DiracHX.Cdirackernels / DiracHX.h
kernels / DivFreeCoupledScalarAdvection.Ckernels / DivFreeCoupledScalarAdvection.h
postprocessors / DivisionPostprocessor.Cpostprocessors / DivisionPostprocessor.h
postprocessors / ElementL2Diff.Cpostprocessors / ElementL2Diff.h
postprocessors / ElmIntegTotFissHeatPostprocessor.Cpostprocessors / ElmIntegTotFissHeatPostprocessor.h
postprocessors / ElmIntegTotFissNtsPostprocessor.Cpostprocessors / ElmIntegTotFissNtsPostprocessor.h
postprocessors / ElmIntegTotFissPostprocessor.Cpostprocessors / ElmIntegTotFissPostprocessor.h
kernels / FissionHeatSource.Ckernels / FissionHeatSource.h
auxkernels / FissionHeatSourceAux.Cauxkernels / FissionHeatSourceAux.h
auxkernels / FissionHeatSourceTransientAux.Cauxkernels / FissionHeatSourceTransientAux.h
kernels / GammaHeatSource.Ckernels / GammaHeatSource.h
materials / GenericMoltresMaterial.Cmaterials / GenericMoltresMaterial.h
materials / GraphiteTwoGrpXSFunctionMaterial.Cmaterials / GraphiteTwoGrpXSFunctionMaterial.h
kernels / GroupDiffusion.Ckernels / GroupDiffusion.h
kernels / HeatPrecursorDecay.Ckernels / HeatPrecursorDecay.h
kernels / HeatPrecursorSource.Ckernels / HeatPrecursorSource.h
kernels / INSADEnergyTurbulentDiffusion.Ckernels / INSADEnergyTurbulentDiffusion.h
bcs / INSADMassPSPGBC.Cbcs / INSADMassPSPGBC.h
bcs / INSADMomentumSUPGBC.Cbcs / INSADMomentumSUPGBC.h
bcs / INSADMomentumTurbulentNoBCBC.Cbcs / INSADMomentumTurbulentNoBCBC.h
kernels / INSADMomentumTurbulentViscous.Ckernels / INSADMomentumTurbulentViscous.h
kernels / INSBoussinesqBodyForce.Ckernels / INSBoussinesqBodyForce.h
kernels / InScatter.Ckernels / InScatter.h
postprocessors / IntegralNewVariablePostprocessor.Cpostprocessors / IntegralNewVariablePostprocessor.h
postprocessors / IntegralOldVariablePostprocessor.Cpostprocessors / IntegralOldVariablePostprocessor.h
postprocessors / LimitK.Cpostprocessors / LimitK.h
bcs / LinLogPenaltyDirichletBC.Cbcs / LinLogPenaltyDirichletBC.h
main.Cbase / MoltresApp.h
auxkernels / MatDiffusionAux.Cauxkernels / MatDiffusionAux.h
bcs / MatDiffusionFluxBC.Cbcs / MatDiffusionFluxBC.h
auxkernels / ModeratorHeatSourceTransientAux.Cauxkernels / ModeratorHeatSourceTransientAux.h
base / MoltresApp.Cbase / MoltresApp.h
materials / MoltresJsonMaterial.Cmaterials / MoltresJsonMaterial.h
materials / MsreFuelTwoGrpXSFunctionMaterial.Cmaterials / MsreFuelTwoGrpXSFunctionMaterial.h
postprocessors / NeutronLeakage.Cpostprocessors / NeutronLeakage.h
actions / NtAction.Cactions / NtAction.h
kernels / NtTimeDerivative.Ckernels / NtTimeDerivative.h
materials / NuclearMaterial.Cmaterials / NuclearMaterial.h
materials / Nusselt.Cmaterials / Nusselt.h
bcs / PostprocessorCoupledInflowBC.Cbcs / PostprocessorCoupledInflowBC.h
actions / PrecursorAction.Cactions / PrecursorAction.h
kernels / PrecursorDecay.Ckernels / PrecursorDecay.h
kernels / PrecursorSource.Ckernels / PrecursorSource.h
materials / RoddedMaterial.Cmaterials / RoddedMaterial.h
materials / SATauMaterial.Cmaterials / SATauMaterial.h
materials / SATauStabilized3Eqn.Cmaterials / SATauStabilized3Eqn.h
kernels / SATimeDerivative.Ckernels / SATimeDerivative.h
kernels / SATurbulentViscosity.Ckernels / SATurbulentViscosity.h
auxkernels / SATurbulentViscosityAux.Cauxkernels / SATurbulentViscosityAux.h
bcs / SATurbulentViscosityNoBCBC.Cbcs / SATurbulentViscosityNoBCBC.h
kernels / SATurbulentViscositySUPG.Ckernels / SATurbulentViscositySUPG.h
bcs / SATurbulentViscositySUPGBC.Cbcs / SATurbulentViscositySUPGBC.h
kernels / ScalarAdvectionArtDiff.Ckernels / ScalarAdvectionArtDiff.h
bcs / ScalarAdvectionArtDiffNoBCBC.Cbcs / ScalarAdvectionArtDiffNoBCBC.h
base / ScalarTransportBase.Cbase / ScalarTransportBase.h
kernels / ScalarTransportTimeDerivative.Ckernels / ScalarTransportTimeDerivative.h
postprocessors / SideWeightedIntegralPostprocessor.Cpostprocessors / SideWeightedIntegralPostprocessor.h
kernels / SigmaR.Ckernels / SigmaR.h
postprocessors / TotalNeutronLeakage.Cpostprocessors / TotalNeutronLeakage.h
kernels / TransientFissionHeatSource.Ckernels / TransientFissionHeatSource.h
auxkernels / TurbulentStressAux.Cauxkernels / TurbulentStressAux.h
bcs / VacuumConcBC.Cbcs / VacuumConcBC.h
actions / VariableNotAMooseObjectAction.Cactions / VariableNotAMooseObjectAction.h
auxkernels / WallDistanceAux.Cauxkernels / WallDistanceAux.h
auxkernels / WallShearStressAux.Cauxkernels / WallShearStressAux.h
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html b/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html index f3bb358a9..ebe714c26 100644 --- a/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html +++ b/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html @@ -99,7 +99,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html b/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html index 54beae903..29c691ac8 100644 --- a/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html +++ b/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html b/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html index f067bdd84..2389a1c2d 100644 --- a/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html +++ b/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html @@ -145,7 +145,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html b/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html index ea795e43e..9550e0e3b 100644 --- a/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html +++ b/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html b/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html index ee948da64..b0b372f08 100644 --- a/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html +++ b/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 745ccee97..17b3a5c01 100644 --- a/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -118,7 +118,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html b/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html index a2e1aa756..56a49f726 100644 --- a/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html +++ b/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html @@ -123,7 +123,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html b/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html index ce6a4d99a..69b617cf8 100644 --- a/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html +++ b/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html b/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html index f436a46c2..9a0ad6d7c 100644 --- a/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html +++ b/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html b/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html index d4a367e93..f8d69c4bb 100644 --- a/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html +++ b/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html b/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html index f03ecd850..62d0cbab7 100644 --- a/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html +++ b/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html b/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html index 451c81e96..d2cbdd228 100644 --- a/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html +++ b/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html @@ -99,7 +99,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html b/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html index 94b7f0f99..7be1e998e 100644 --- a/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html +++ b/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html b/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html index 1fce33ab9..18a8b8621 100644 --- a/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html +++ b/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html @@ -123,7 +123,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html b/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html index da0c0ef14..42b35ffe1 100644 --- a/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html +++ b/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html @@ -119,7 +119,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html b/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html index fc8134a45..06473746a 100644 --- a/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html +++ b/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html @@ -101,7 +101,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html b/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html index 59fc343c9..fadf52ec5 100644 --- a/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html @@ -113,7 +113,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_e313ae6235229141100fd0edcf178102.html b/doxygen/dir_e313ae6235229141100fd0edcf178102.html index 3c7ec487e..604086d68 100644 --- a/doxygen/dir_e313ae6235229141100fd0edcf178102.html +++ b/doxygen/dir_e313ae6235229141100fd0edcf178102.html @@ -97,7 +97,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html b/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html index dab8c210d..f5376e1d3 100644 --- a/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html +++ b/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html @@ -117,7 +117,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html b/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html index b8c151434..2b3a9d8c3 100644 --- a/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html +++ b/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html @@ -145,7 +145,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/files.html b/doxygen/files.html index 3eb771e9c..7c79c749c 100644 --- a/doxygen/files.html +++ b/doxygen/files.html @@ -263,7 +263,7 @@
-Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
diff --git a/doxygen/functions.html b/doxygen/functions.html index 9e2a87fb9..7eb6418b4 100644 --- a/doxygen/functions.html +++ b/doxygen/functions.html @@ -260,7 +260,7 @@

- _ -

    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
    diff --git a/doxygen/functions_a.html b/doxygen/functions_a.html index 524c75ee1..a4776a36d 100644 --- a/doxygen/functions_a.html +++ b/doxygen/functions_a.html @@ -102,7 +102,7 @@

    - a -

      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
      diff --git a/doxygen/functions_b.html b/doxygen/functions_b.html index 58ac5f078..7d1616dc7 100644 --- a/doxygen/functions_b.html +++ b/doxygen/functions_b.html @@ -86,7 +86,7 @@

      - b -

        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
        diff --git a/doxygen/functions_c.html b/doxygen/functions_c.html index 2f891a2e5..7d9ff3780 100644 --- a/doxygen/functions_c.html +++ b/doxygen/functions_c.html @@ -110,7 +110,7 @@

        - c -

          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
          diff --git a/doxygen/functions_d.html b/doxygen/functions_d.html index d4272469e..081c65a58 100644 --- a/doxygen/functions_d.html +++ b/doxygen/functions_d.html @@ -91,7 +91,7 @@

          - d -

            -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
            diff --git a/doxygen/functions_e.html b/doxygen/functions_e.html index 50f8699e1..3063aae5f 100644 --- a/doxygen/functions_e.html +++ b/doxygen/functions_e.html @@ -88,7 +88,7 @@

            - e -

              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_enum.html b/doxygen/functions_enum.html index 53aa40125..858faeda8 100644 --- a/doxygen/functions_enum.html +++ b/doxygen/functions_enum.html @@ -82,7 +82,7 @@
              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_eval.html b/doxygen/functions_eval.html index 59445c3d1..6b52903d2 100644 --- a/doxygen/functions_eval.html +++ b/doxygen/functions_eval.html @@ -87,7 +87,7 @@
              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_f.html b/doxygen/functions_f.html index da3a7ea16..c1465ca79 100644 --- a/doxygen/functions_f.html +++ b/doxygen/functions_f.html @@ -88,7 +88,7 @@

              - f -

                -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                diff --git a/doxygen/functions_func.html b/doxygen/functions_func.html index 9295d21ab..3dbd8d5e2 100644 --- a/doxygen/functions_func.html +++ b/doxygen/functions_func.html @@ -102,7 +102,7 @@

                - a -

                  -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                  diff --git a/doxygen/functions_func_b.html b/doxygen/functions_func_b.html index cad3bcefd..bd3afb046 100644 --- a/doxygen/functions_func_b.html +++ b/doxygen/functions_func_b.html @@ -85,7 +85,7 @@

                  - b -

                    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                    diff --git a/doxygen/functions_func_c.html b/doxygen/functions_func_c.html index 4cec58aa5..fcbf0404b 100644 --- a/doxygen/functions_func_c.html +++ b/doxygen/functions_func_c.html @@ -110,7 +110,7 @@

                    - c -

                      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                      diff --git a/doxygen/functions_func_d.html b/doxygen/functions_func_d.html index 68e857fa8..6ee88eb9e 100644 --- a/doxygen/functions_func_d.html +++ b/doxygen/functions_func_d.html @@ -91,7 +91,7 @@

                      - d -

                        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                        diff --git a/doxygen/functions_func_e.html b/doxygen/functions_func_e.html index f231ae689..1cd12a033 100644 --- a/doxygen/functions_func_e.html +++ b/doxygen/functions_func_e.html @@ -88,7 +88,7 @@

                        - e -

                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                          diff --git a/doxygen/functions_func_f.html b/doxygen/functions_func_f.html index b54833736..50f095fa0 100644 --- a/doxygen/functions_func_f.html +++ b/doxygen/functions_func_f.html @@ -88,7 +88,7 @@

                          - f -

                            -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                            diff --git a/doxygen/functions_func_g.html b/doxygen/functions_func_g.html index e6b2e8784..909abf5e7 100644 --- a/doxygen/functions_func_g.html +++ b/doxygen/functions_func_g.html @@ -89,7 +89,7 @@

                            - g -

                              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                              diff --git a/doxygen/functions_func_h.html b/doxygen/functions_func_h.html index e77fc8e78..0e1a892ba 100644 --- a/doxygen/functions_func_h.html +++ b/doxygen/functions_func_h.html @@ -85,7 +85,7 @@

                              - h -

                                -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                diff --git a/doxygen/functions_func_i.html b/doxygen/functions_func_i.html index dc1cc77b0..b04eee083 100644 --- a/doxygen/functions_func_i.html +++ b/doxygen/functions_func_i.html @@ -94,7 +94,7 @@

                                - i -

                                  -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                  diff --git a/doxygen/functions_func_l.html b/doxygen/functions_func_l.html index 55a6c276b..2bf14c14e 100644 --- a/doxygen/functions_func_l.html +++ b/doxygen/functions_func_l.html @@ -88,7 +88,7 @@

                                  - l -

                                    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                    diff --git a/doxygen/functions_func_m.html b/doxygen/functions_func_m.html index 2fa46ca61..be0018162 100644 --- a/doxygen/functions_func_m.html +++ b/doxygen/functions_func_m.html @@ -91,7 +91,7 @@

                                    - m -

                                      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                      diff --git a/doxygen/functions_func_n.html b/doxygen/functions_func_n.html index 2459a7755..355fbb540 100644 --- a/doxygen/functions_func_n.html +++ b/doxygen/functions_func_n.html @@ -88,7 +88,7 @@

                                      - n -

                                        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                        diff --git a/doxygen/functions_func_p.html b/doxygen/functions_func_p.html index cb0090b9b..754404341 100644 --- a/doxygen/functions_func_p.html +++ b/doxygen/functions_func_p.html @@ -90,7 +90,7 @@

                                        - p -

                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                          diff --git a/doxygen/functions_func_q.html b/doxygen/functions_func_q.html index b64714373..d300b93bd 100644 --- a/doxygen/functions_func_q.html +++ b/doxygen/functions_func_q.html @@ -85,7 +85,7 @@

                                          - q -

                                            -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                            diff --git a/doxygen/functions_func_r.html b/doxygen/functions_func_r.html index b809c03ff..a983e2a5a 100644 --- a/doxygen/functions_func_r.html +++ b/doxygen/functions_func_r.html @@ -86,7 +86,7 @@

                                            - r -

                                              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                              diff --git a/doxygen/functions_func_s.html b/doxygen/functions_func_s.html index 08f158c5a..f9941b5c7 100644 --- a/doxygen/functions_func_s.html +++ b/doxygen/functions_func_s.html @@ -101,7 +101,7 @@

                                              - s -

                                                -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                diff --git a/doxygen/functions_func_t.html b/doxygen/functions_func_t.html index 7cee30364..70ef56c6e 100644 --- a/doxygen/functions_func_t.html +++ b/doxygen/functions_func_t.html @@ -88,7 +88,7 @@

                                                - t -

                                                  -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                  diff --git a/doxygen/functions_func_v.html b/doxygen/functions_func_v.html index 7fac03c82..cd0563f4e 100644 --- a/doxygen/functions_func_v.html +++ b/doxygen/functions_func_v.html @@ -86,7 +86,7 @@

                                                  - v -

                                                    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                    diff --git a/doxygen/functions_func_w.html b/doxygen/functions_func_w.html index e2f34e63c..725c5ce7d 100644 --- a/doxygen/functions_func_w.html +++ b/doxygen/functions_func_w.html @@ -85,7 +85,7 @@

                                                    - w -

                                                      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                      diff --git a/doxygen/functions_func_~.html b/doxygen/functions_func_~.html index 1b0df7e0d..3998a345f 100644 --- a/doxygen/functions_func_~.html +++ b/doxygen/functions_func_~.html @@ -90,7 +90,7 @@

                                                      - ~ -

                                                        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                        diff --git a/doxygen/functions_g.html b/doxygen/functions_g.html index 1ca3623d7..5a6cd5741 100644 --- a/doxygen/functions_g.html +++ b/doxygen/functions_g.html @@ -89,7 +89,7 @@

                                                        - g -

                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                          diff --git a/doxygen/functions_h.html b/doxygen/functions_h.html index 49a630544..f37341505 100644 --- a/doxygen/functions_h.html +++ b/doxygen/functions_h.html @@ -85,7 +85,7 @@

                                                          - h -

                                                            -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                            diff --git a/doxygen/functions_i.html b/doxygen/functions_i.html index 1ef9a7389..424aa9cfb 100644 --- a/doxygen/functions_i.html +++ b/doxygen/functions_i.html @@ -95,7 +95,7 @@

                                                            - i -

                                                              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                              diff --git a/doxygen/functions_l.html b/doxygen/functions_l.html index 055b206fe..74001ece4 100644 --- a/doxygen/functions_l.html +++ b/doxygen/functions_l.html @@ -90,7 +90,7 @@

                                                              - l -

                                                                -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                diff --git a/doxygen/functions_m.html b/doxygen/functions_m.html index 9fb7275bb..b0abcbb31 100644 --- a/doxygen/functions_m.html +++ b/doxygen/functions_m.html @@ -92,7 +92,7 @@

                                                                - m -

                                                                  -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                  diff --git a/doxygen/functions_n.html b/doxygen/functions_n.html index b49f3cd61..8a05b116d 100644 --- a/doxygen/functions_n.html +++ b/doxygen/functions_n.html @@ -89,7 +89,7 @@

                                                                  - n -

                                                                    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                    diff --git a/doxygen/functions_p.html b/doxygen/functions_p.html index 3341aaef3..4b5e2d05f 100644 --- a/doxygen/functions_p.html +++ b/doxygen/functions_p.html @@ -90,7 +90,7 @@

                                                                    - p -

                                                                      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                      diff --git a/doxygen/functions_q.html b/doxygen/functions_q.html index a76eafa4e..e296f86cf 100644 --- a/doxygen/functions_q.html +++ b/doxygen/functions_q.html @@ -85,7 +85,7 @@

                                                                      - q -

                                                                        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                        diff --git a/doxygen/functions_r.html b/doxygen/functions_r.html index 0204b53f0..c5d627ff2 100644 --- a/doxygen/functions_r.html +++ b/doxygen/functions_r.html @@ -86,7 +86,7 @@

                                                                        - r -

                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                          diff --git a/doxygen/functions_s.html b/doxygen/functions_s.html index 22a854eb9..4e9988d54 100644 --- a/doxygen/functions_s.html +++ b/doxygen/functions_s.html @@ -102,7 +102,7 @@

                                                                          - s -

                                                                            -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                            diff --git a/doxygen/functions_t.html b/doxygen/functions_t.html index 08f3a49fd..eb8e2d962 100644 --- a/doxygen/functions_t.html +++ b/doxygen/functions_t.html @@ -88,7 +88,7 @@

                                                                            - t -

                                                                              -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                              diff --git a/doxygen/functions_v.html b/doxygen/functions_v.html index 376e2c15c..d6df82d2c 100644 --- a/doxygen/functions_v.html +++ b/doxygen/functions_v.html @@ -86,7 +86,7 @@

                                                                              - v -

                                                                                -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                diff --git a/doxygen/functions_vars.html b/doxygen/functions_vars.html index c052a0eae..c4179e15c 100644 --- a/doxygen/functions_vars.html +++ b/doxygen/functions_vars.html @@ -260,7 +260,7 @@

                                                                                - _ -

                                                                                  -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                  diff --git a/doxygen/functions_w.html b/doxygen/functions_w.html index c5f5fec34..b8bb07345 100644 --- a/doxygen/functions_w.html +++ b/doxygen/functions_w.html @@ -85,7 +85,7 @@

                                                                                  - w -

                                                                                    -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                    diff --git a/doxygen/functions_~.html b/doxygen/functions_~.html index f31035f53..b94b86470 100644 --- a/doxygen/functions_~.html +++ b/doxygen/functions_~.html @@ -90,7 +90,7 @@

                                                                                    - ~ -

                                                                                      -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                      diff --git a/doxygen/globals.html b/doxygen/globals.html index 58a04dca1..73dd6c1cc 100644 --- a/doxygen/globals.html +++ b/doxygen/globals.html @@ -98,7 +98,7 @@

                                                                                      - s -

                                                                                        -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                        diff --git a/doxygen/globals_func.html b/doxygen/globals_func.html index 6ac03a241..e528d393c 100644 --- a/doxygen/globals_func.html +++ b/doxygen/globals_func.html @@ -93,7 +93,7 @@

                                                                                        - r -

                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/globals_type.html b/doxygen/globals_type.html index 2170f965c..ca44a5014 100644 --- a/doxygen/globals_type.html +++ b/doxygen/globals_type.html @@ -82,7 +82,7 @@
                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/graph_legend.html b/doxygen/graph_legend.html index af6ea32b7..09b71ee7b 100644 --- a/doxygen/graph_legend.html +++ b/doxygen/graph_legend.html @@ -142,7 +142,7 @@
                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/hierarchy.html b/doxygen/hierarchy.html index d9d6f2e34..989aaf053 100644 --- a/doxygen/hierarchy.html +++ b/doxygen/hierarchy.html @@ -219,7 +219,7 @@
                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/index.html b/doxygen/index.html index afbf85e54..1f6fd3650 100644 --- a/doxygen/index.html +++ b/doxygen/index.html @@ -82,7 +82,7 @@
                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/inherits.html b/doxygen/inherits.html index 4e2572847..2f968976e 100644 --- a/doxygen/inherits.html +++ b/doxygen/inherits.html @@ -108,7 +108,7 @@
                                                                                          -Generated on Fri May 31 2024 21:06:13 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:38 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/main_8_c.html b/doxygen/main_8_c.html index 40e56e727..44f9be984 100644 --- a/doxygen/main_8_c.html +++ b/doxygen/main_8_c.html @@ -130,7 +130,7 @@

                                                                                          -Generated on Fri May 31 2024 21:06:12 for moltres by doxygen 1.9.8 +Generated on Wed Jun 5 2024 01:06:37 for moltres by doxygen 1.9.8
                                                                                          diff --git a/getting_started/eigenvalue.html b/getting_started/eigenvalue.html index 8dd2a528e..f3db83f2c 100644 --- a/getting_started/eigenvalue.html +++ b/getting_started/eigenvalue.html @@ -1 +1 @@ -Eigenvalue Calculation with NtAction | Moltres

                                                                                          Eigenvalue Calculation with NtAction

                                                                                          The input files associated with this tutorial are moltres/tutorial/eigenvalue/nts.i and moltres/tutorial/eigenvalue/nts-action.i. Refer to Tutorial 2a for an introduction on the input file syntax and in-depth descriptions of every input parameter.

                                                                                          As mentioned in Tutorial 2a, this example involves a simple 2-D axisymmetric core model of the Molten Salt Reactor Experiment (MSRE) that was developed at Oak Ridge National Laboratory. The figure below shows the 2-D MSRE model for this tutorial. It is a 70.8 cm by 169 cm rectangle that is axisymmetric about the left boundary. The domain consists of 14 fuel channels, alternating with 14 solid graphite moderator regions, represented in the figure by gray and red rectangles, respectively.

                                                                                          Figure 1: 2-D axisymmetric model of the MSRE

                                                                                          For multiplication factor () eigenvalue calculations, Moltres relies on the Eigenvalue executioner from MOOSE. These executioners solve the neutron diffusion equations set up as an eigenvalue problem to find and the neutron flux distribution, which occur as the absolute minimum eigenvalue and the corresponding eigenvector of the system.

                                                                                          The MOOSE Action system allows us to streamline and simplify creating input files for Moltres simulations. You will have encountered the PrecursorAction object in Tutorial 2a for setting up input parameters for delayed neutron precursors. PrecursorAction automatically sets up the required Variables, Kernels, BCs, etc. governing precursor production, decay, and drift. Otherwise, users will need to fill in every input object for six or eight precursor groups, which would undoubtedly result in a very long input file prone to typos and user error. Similarly, we created NtAction for neutron group fluxes since many reactor simulations involve more than two neutron energy groups.

                                                                                          Both nts.i and nts-action.i set up the same eigenvalue problem for a 2-D axisymmetric MSRE model. The model parameters are as follows:

                                                                                          • Two neutron energy groups

                                                                                          • Six delayed neutron precursor groups

                                                                                          • Vacuum boundary conditions along the top, bottom and outer boundaries of the axisymmetric cylinder

                                                                                          • Uniform temperature of 900K

                                                                                          • Uniform salt flow upwards along the fuel channels at 18.085cm/s

                                                                                          • No salt looping (precursors that flow out of the core without decaying are considered lost)

                                                                                          Both input files produce the same neutron flux and precursor distributions. You may compare them to identify the objects that NtAction automatically initializes, and appreciate how much cleaner nts-action.i looks compared to nts.i.

                                                                                          Results and discussion to come at a later date.

                                                                                            \ No newline at end of file +Eigenvalue Calculation with NtAction | Moltres

                                                                                            Eigenvalue Calculation with NtAction

                                                                                            The input files associated with this tutorial are moltres/tutorial/eigenvalue/nts.i and moltres/tutorial/eigenvalue/nts-action.i. Refer to Tutorial 2a for an introduction on the input file syntax and in-depth descriptions of every input parameter.

                                                                                            As mentioned in Tutorial 2a, this example involves a simple 2-D axisymmetric core model of the Molten Salt Reactor Experiment (MSRE) that was developed at Oak Ridge National Laboratory. The figure below shows the 2-D MSRE model for this tutorial. It is a 70.8 cm by 169 cm rectangle that is axisymmetric about the left boundary. The domain consists of 14 fuel channels, alternating with 14 solid graphite moderator regions, represented in the figure by gray and red rectangles, respectively.

                                                                                            Figure 1: 2-D axisymmetric model of the MSRE

                                                                                            For multiplication factor () eigenvalue calculations, Moltres relies on the Eigenvalue executioner from MOOSE. These executioners solve the neutron diffusion equations set up as an eigenvalue problem to find and the neutron flux distribution, which occur as the absolute minimum eigenvalue and the corresponding eigenvector of the system.

                                                                                            The MOOSE Action system allows us to streamline and simplify creating input files for Moltres simulations. You will have encountered the PrecursorAction object in Tutorial 2a for setting up input parameters for delayed neutron precursors. PrecursorAction automatically sets up the required Variables, Kernels, BCs, etc. governing precursor production, decay, and drift. Otherwise, users will need to fill in every input object for six or eight precursor groups, which would undoubtedly result in a very long input file prone to typos and user error. Similarly, we created NtAction for neutron group fluxes since many reactor simulations involve more than two neutron energy groups.

                                                                                            Both nts.i and nts-action.i set up the same eigenvalue problem for a 2-D axisymmetric MSRE model. The model parameters are as follows:

                                                                                            • Two neutron energy groups

                                                                                            • Six delayed neutron precursor groups

                                                                                            • Vacuum boundary conditions along the top, bottom and outer boundaries of the axisymmetric cylinder

                                                                                            • Uniform temperature of 900K

                                                                                            • Uniform salt flow upwards along the fuel channels at 18.085cm/s

                                                                                            • No salt looping (precursors that flow out of the core without decaying are considered lost)

                                                                                            Both input files produce the same neutron flux and precursor distributions. You may compare them to identify the objects that NtAction automatically initializes, and appreciate how much cleaner nts-action.i looks compared to nts.i.

                                                                                            Results and discussion to come at a later date.

                                                                                              \ No newline at end of file diff --git a/getting_started/input_syntax.html b/getting_started/input_syntax.html index 410318724..e2fa03c09 100644 --- a/getting_started/input_syntax.html +++ b/getting_started/input_syntax.html @@ -1,11 +1,11 @@ -Introduction to the Moltres Input File Syntax | Moltres

                                                                                              Introduction to the Moltres Input File Syntax

                                                                                              The input file example documented here is taken from moltres/tutorial/eigenvalue/nts.i for the Eigenvalue Calculation tutorial. This is a simple 2-D axisymmetric core model of the Molten Salt Reactor Experiment (MSRE) that was developed at Oak Ridge National Laboratory and was operated from 1965 through 1969. Simulation results from a similar 2-D model are documented in the article, Introduction to Moltres: An application for simulation of Molten Salt Reactors, which discusses simulation results, and compares them to a 3-D Moltres model of the MSRE and to MSRE data and calculated results.

                                                                                              Assuming that Moltres has been successfully compiled, to execute this input file from the command line, run the following from a terminal window, substituting $moltres_root with the path to the Moltres root directory:

                                                                                              
+Introduction to the Moltres Input File Syntax | Moltres
                                                                                              Introduction to the Moltres Input File Syntax
                                                                                              The input file example documented here is taken from moltres/tutorial/eigenvalue/nts.i for the Eigenvalue Calculation tutorial. This is a simple 2-D axisymmetric core model of the Molten Salt Reactor Experiment (MSRE) that was developed at Oak Ridge National Laboratory and was operated from 1965 through 1969. Simulation results from a similar 2-D model are documented in the article, Introduction to Moltres: An application for simulation of Molten Salt Reactors, which discusses simulation results, and compares them to a 3-D Moltres model of the MSRE and to MSRE data and calculated results. 
                                                                                              Assuming that Moltres has been successfully compiled, to execute this input file from the command line, run the following from a terminal window, substituting $moltres_root with the path to the Moltres root directory:
                                                                                              
 cd $moltres_root/tutorial/eigenvalue
 ../../moltres-opt -i nts.i
 
                                                                                              In serial, this job takes around 9 seconds on a 4.3 GHz machine. To run the job in parallel, execute:
                                                                                              
 mpirun -n 2 ../../moltres-opt -i nts.i
-
                                                                                              where the number of processors can be changed from 2 to however many processes you want to run. The parallel performance of the job depends on the number of degrees of freedom in the problem and the preconditioner used. A general rule of thumb for optimal scaling is not to go below 10k degrees of freedom per processor, otherwise communication becomes a performance drag. Additionally many preconditioners do not perform as well when spread over multiple processes as they lose access to "new" information. (See http://www.mcs.anl.gov/petsc/documentation/faq.html#slowerparallel for more discussion of this). This particular input file (nts.i) only has 9,308 degrees of freedom so communication is a factor; we can get faster solution time with more processors, albeit at sublinear scaling. On the same 4.3 GHz machine, the solution times for 1-4 processors are given below.
                                                                                              • Single processor solution time: 9.1 seconds 
                                                                                              • Two processors: 5.4 seconds 
                                                                                              • Four processors: 3.6 seconds
                                                                                              The Exodus output file corresponding to the input file under discussion will be generated as nts.e after running the input file. The most common application for visualizing Exodus files is ParaView, although VisIt or yt may also be used.
                                                                                              Model Geometry
                                                                                              The figure below shows the domain for the 2-D MSRE model. It is a 72.2 cm by 165 cm rectangle that is axisymmetric about the left boundary. The domain consists of 14 fuel channels, alternating with 14 solid graphite moderator regions, represented in the figure by gray and red rectangles, respectively.
                                                                                              Figure 1: 2-D axisymmetric model of the MSRE
                                                                                              File Format
                                                                                              Moltres is built on top of the MOOSE framework, and the input file uses the "hierarchical input text format" (hit) input format adopted by MOOSE. A brief description of the input syntax is presented here. This is a relatively simple file format that uses [names in brackets] to mark the start of input blocks. Empty brackets [] are used to indicate the end of a block. Note that block names and parameter names are generally case sensitive in the input file. In addition, in Moltres/MOOSE input files, the # symbol is used to mark the start of a comment. Comments may start anywhere on a line.
                                                                                              Substitution Variables
                                                                                              Root level variables can be used as substitution variables throughout the document by using the syntax ${varname}. Starting at the top of the input file, the following substitution variables are defined:
                                                                                              
+
                                                                                              where the number of processors can be changed from 2 to however many processes you want to run. The parallel performance of the job depends on the number of degrees of freedom in the problem and the preconditioner used. A general rule of thumb for optimal scaling is not to go below 10k degrees of freedom per processor, otherwise communication becomes a performance drag. Additionally many preconditioners do not perform as well when spread over multiple processes as they lose access to "new" information. (See http://www.mcs.anl.gov/petsc/documentation/faq.html#slowerparallel for more discussion of this). This particular input file (nts.i) only has 9,308 degrees of freedom so communication is a factor; we can get faster solution time with more processors, albeit at sublinear scaling. On the same 4.3 GHz machine, the solution times for 1-4 processors are given below.
                                                                                              • Single processor solution time: 9.1 seconds 
                                                                                              • Two processors: 5.4 seconds 
                                                                                              • Four processors: 3.6 seconds
                                                                                              The Exodus output file corresponding to the input file under discussion will be generated as nts.e after running the input file. The most common application for visualizing Exodus files is ParaView, although VisIt or yt may also be used.
                                                                                              Model Geometry
                                                                                              The figure below shows the domain for the 2-D MSRE model. It is a 72.2 cm by 165 cm rectangle that is axisymmetric about the left boundary. The domain consists of 14 fuel channels, alternating with 14 solid graphite moderator regions, represented in the figure by gray and red rectangles, respectively.
                                                                                              Figure 1: 2-D axisymmetric model of the MSRE
                                                                                              File Format
                                                                                              Moltres is built on top of the MOOSE framework, and the input file uses the "hierarchical input text format" (hit) input format adopted by MOOSE. A brief description of the input syntax is presented here. This is a relatively simple file format that uses [names in brackets] to mark the start of input blocks. Empty brackets [] are used to indicate the end of a block. Note that block names and parameter names are generally case sensitive in the input file. In addition, in Moltres/MOOSE input files, the # symbol is used to mark the start of a comment. Comments may start anywhere on a line.
                                                                                              Substitution Variables
                                                                                              Root level variables can be used as substitution variables throughout the document by using the syntax ${varname}. Starting at the top of the input file, the following substitution variables are defined:
                                                                                              
 flow_velocity=17.55  # cm/s
-
                                                                                              flow_velocity is used to set the upward flow velocity of the fuel/molten salt in this model. Comments can be added after the # character for inline documentation.
                                                                                              You may set the flow velocity to zero to obtain the multiplication factor of this system without delayed neutron precursor (DNP) drift. Note that this input file does not model the looping of DNPs back into the core after flowing through out-of-core components. Therefore, all DNPs flowing out of the core are considered lost.
                                                                                              GlobalParams Block
                                                                                              Following the substitution variable definitions, we have the GlobalParams block:
                                                                                              
+
                                                                                              flow_velocity is used to set the upward flow velocity of the fuel/molten salt in this model. Comments can be added after the # character for inline documentation.
                                                                                              You may set the flow velocity to zero to obtain the multiplication factor of this system without delayed neutron precursor (DNP) drift. Note that this input file does not model the looping of DNPs back into the core after flowing through out-of-core components. Therefore, all DNPs flowing out of the core are considered lost.
                                                                                              GlobalParams Block
                                                                                              Following the substitution variable definitions, we have the GlobalParams block:
                                                                                              
 [GlobalParams]
   num_groups = 2
   num_precursor_groups = 6
@@ -16,7 +16,7 @@
   pre_concs = 'pre1 pre2 pre3 pre4 pre5 pre6'
   account_delayed = true
 []
-
                                                                                              In GlobalParams, parameters like num_groups can be globally set to a value. Consequently any class (e.g. the kernel class GroupDiffusion) that has the parameter num_groups will read in a value of 2 unless it is overridden locally in its input block. It should be noted that the GlobalParams block and any other MOOSE input block can be placed anywhere in the input file. At execution time each block will be read when it is needed. Below is a description of the parameters included in the GlobalParams section:
                                                                                              • num_groups: The number of energy groups for neutron diffusion 
                                                                                              • num_precursor_groups: The number of delayed neutron precursor groups 
                                                                                              • use_exp_form: Whether the actual neutron/precursor fluxes/concentrations should be represented by  or  where  is the actual variable value 
                                                                                              • group_fluxes: The names of the neutron group fluxes 
                                                                                              • temperature: The name of the temperature variable. Some of the kernel or boundary  condition variables require an input named temperature which specifies the  variable used to represent temperature. The variable temp will be specified  below in the [Variables] block. 
                                                                                              • sss2_input: True if the macroscopic group constants were generated by Serpent 2 or OpenMC. False otherwise 
                                                                                              • pre_concs: The names of the precursor concentration variables 
                                                                                              • account_delayed: Whether to account for delayed neutron production. Modifies the neutron source term
                                                                                              Mesh Block
                                                                                              Next in our input file we have the Mesh block. The two most commonly used Mesh types are FileMesh and GeneratedMesh. The Mesh input block by default assumes type FileMesh and takes a parameter argument file = <mesh_file_name>.
                                                                                              
+
                                                                                              In GlobalParams, parameters like num_groups can be globally set to a value. Consequently any class (e.g. the kernel class GroupDiffusion) that has the parameter num_groups will read in a value of 2 unless it is overridden locally in its input block. It should be noted that the GlobalParams block and any other MOOSE input block can be placed anywhere in the input file. At execution time each block will be read when it is needed. Below is a description of the parameters included in the GlobalParams section:
                                                                                              • num_groups: The number of energy groups for neutron diffusion 
                                                                                              • num_precursor_groups: The number of delayed neutron precursor groups 
                                                                                              • use_exp_form: Whether the actual neutron/precursor fluxes/concentrations should be represented by  or  where  is the actual variable value 
                                                                                              • group_fluxes: The names of the neutron group fluxes 
                                                                                              • temperature: The name of the temperature variable. Some of the kernel or boundary  condition variables require an input named temperature which specifies the  variable used to represent temperature. The variable temp will be specified  below in the [Variables] block. 
                                                                                              • sss2_input: True if the macroscopic group constants were generated by Serpent 2 or OpenMC. False otherwise 
                                                                                              • pre_concs: The names of the precursor concentration variables 
                                                                                              • account_delayed: Whether to account for delayed neutron production. Modifies the neutron source term
                                                                                              Mesh Block
                                                                                              Next in our input file we have the Mesh block. The two most commonly used Mesh types are FileMesh and GeneratedMesh. The Mesh input block by default assumes type FileMesh and takes a parameter argument file = <mesh_file_name>.
                                                                                              
 [Mesh]
   coord_type = RZ
   [mesh]
@@ -26,12 +26,12 @@
 []
 
                                                                                              We use coord_type to indicate to Moltres that this is a 2-D axisymmetric problem. By default, it takes a xy-coordinate mesh and considers the y-axis (x=0) to be the axis of symmetry.
                                                                                              MOOSE has an extensive MeshGenerators system for generating simple meshes or making simple edits. We refer the reader here for more information about the system. The mesh.i file uses this system to generate the mesh for the parallel channel structure of the 2-D MSRE model. The 'mesh.e' file for this tutorial can be generated by running the following command:
                                                                                              
 ../../moltres-opt -i mesh.i --mesh-only mesh.e
-
                                                                                              Many MOOSE users generate more complex meshes using Cubit/Trelis. For national lab employees this software is free; however, academic or industry users must pay. Consequently, many of Moltres meshes to date have been generated using MeshGenerators or the open-source software gmsh. Gmsh binaries for Windows, Mac, and Linux as well as source code can be downloaded here. Ubuntu users may also install Gmsh using sudo apt-get install gmsh. We will not go into the details of using Gmsh but the interested user should peruse its documentation. There are many example Gmsh input files in the Moltres repository (denoted by the .geo extension). To generate a mesh for use with Moltres, a typical bash command is gmsh -2 -o file_name.msh file_name.geo where 2 should be replaced with the dimension of the mesh, the argument following -o is the name of the output .msh file, and the last argument is the input .geo file.
                                                                                              Problem Block
                                                                                              The Problem block is used to indicate the type of problem we are solving. MOOSE automatically identifies which problem class is suitable for your simulation type (e.g., FEProblem or EigenProblem). However, for this particular input file, we want to set the bx_norm parameter for determining the eigenvalue estimate during each iteration of the eigensolver. Therefore, this input file requires us to indicate the problem type and the bx_norm parameter.
                                                                                              
+
                                                                                              Many MOOSE users generate more complex meshes using Cubit/Trelis. For national lab employees this software is free; however, academic or industry users must pay. Consequently, many of Moltres meshes to date have been generated using MeshGenerators or the open-source software gmsh. Gmsh binaries for Windows, Mac, and Linux as well as source code can be downloaded here. Ubuntu users may also install Gmsh using sudo apt-get install gmsh. We will not go into the details of using Gmsh but the interested user should peruse its documentation. There are many example Gmsh input files in the Moltres repository (denoted by the .geo extension). To generate a mesh for use with Moltres, a typical bash command is gmsh -2 -o file_name.msh file_name.geo where 2 should be replaced with the dimension of the mesh, the argument following -o is the name of the output .msh file, and the last argument is the input .geo file.
                                                                                              Problem Block
                                                                                              The Problem block is used to indicate the type of problem we are solving. MOOSE automatically identifies which problem class is suitable for your simulation type (e.g., FEProblem or EigenProblem). However, for this particular input file, we want to set the bx_norm parameter for determining the eigenvalue estimate during each iteration of the eigensolver. Therefore, this input file requires us to indicate the problem type and the bx_norm parameter.
                                                                                              
 [Problem]
   type = EigenProblem
   bx_norm = bnorm
 []
-
                                                                                              Variables Block
                                                                                              The Variables block is used to indicate the primary solution variables, or equivalently, to indicate the number of partial differential equations (PDEs) that will be defined in the Kernels and BCs blocks. For this model, the group1 and group2 neutron fluxes are the system variables that are being solved for by the PDEs. In the Kernels and BCs blocks described below, each kernel and BC term must be associated with one primary variable from the Variables list below to indicate which PDE the term is included in.
                                                                                              
+
                                                                                              Variables Block
                                                                                              The Variables block is used to indicate the primary solution variables, or equivalently, to indicate the number of partial differential equations (PDEs) that will be defined in the Kernels and BCs blocks. For this model, the group1 and group2 neutron fluxes are the system variables that are being solved for by the PDEs. In the Kernels and BCs blocks described below, each kernel and BC term must be associated with one primary variable from the Variables list below to indicate which PDE the term is included in.
                                                                                              
 [Variables]
   [group1]
     order = FIRST
@@ -42,7 +42,7 @@
     family = LAGRANGE
   []
 []
-
                                                                                              Sub-blocks are initialized with [<object_name>] and closed with []. The [group1] sub-block creates a MooseVariable object with the name group1. The parameters purpose of the parameter is as follows:
                                                                                              • family describes the shape function type used to form the approximate finite element solution. 
                                                                                              • order denotes the polynomial order of the shape functions. 
                                                                                              • initial_condition is an optional parameter that can be used to set a spatially uniform initial value for the variable. 
                                                                                              • scaling is another optional parameter that can be used to scale the residual of the corresponding variable; this is usually done when different variables have residuals of different orders of magnitude.
                                                                                              Precursors Block
                                                                                              Whereas all the other blocks that have been introduced are standard MOOSE blocks, Precursors is a custom input file block unique to Moltres. The Precursors action sets up the delayed neutron precursor concentration equations:
                                                                                              The precursor variables, kernels, and boundary conditions necessary for solving the precursor governing equations are all instantiated by the Precursors action. Six precursor groups (symbolized by the index i in the equation above) are modeled, as specified via the num_precursor_groups in the GlobalParams block.  is the number of neutron flux energy groups, and  is the index associated with the energy groups. For this problem two energy groups are modeled, with the equations configured explicitly in the Kernels and BCs blocks documented after this section.
                                                                                              
+
                                                                                              Sub-blocks are initialized with [<object_name>] and closed with []. The [group1] sub-block creates a MooseVariable object with the name group1. The parameters purpose of the parameter is as follows:
                                                                                              • family describes the shape function type used to form the approximate finite element solution. 
                                                                                              • order denotes the polynomial order of the shape functions. 
                                                                                              • initial_condition is an optional parameter that can be used to set a spatially uniform initial value for the variable. 
                                                                                              • scaling is another optional parameter that can be used to scale the residual of the corresponding variable; this is usually done when different variables have residuals of different orders of magnitude.
                                                                                              Precursors Block
                                                                                              Whereas all the other blocks that have been introduced are standard MOOSE blocks, Precursors is a custom input file block unique to Moltres. The Precursors action sets up the delayed neutron precursor concentration equations:
                                                                                              The precursor variables, kernels, and boundary conditions necessary for solving the precursor governing equations are all instantiated by the Precursors action. Six precursor groups (symbolized by the index i in the equation above) are modeled, as specified via the num_precursor_groups in the GlobalParams block.  is the number of neutron flux energy groups, and  is the index associated with the energy groups. For this problem two energy groups are modeled, with the equations configured explicitly in the Kernels and BCs blocks documented after this section.
                                                                                              
 [Precursors]
   [./pres]
     var_name_base = pre
@@ -60,7 +60,7 @@
     eigen = true
   [../]
 []
-
                                                                                              Parameter descriptions:
                                                                                              • var_name_base: The prefix for the precursor variable names. Name suffixes are numbers, e.g. pre1, pre2, ... 
                                                                                              • block: This is a parameter ubiquitous to many MOOSE classes such as kernels and materials. By specifying a value for block the user is asking that in this case, precursors and their associated governing equations only be solved for in the fuel mesh subdomains 
                                                                                              • outlet_boundaries: The mesh boundaries from which the precursors flow out 
                                                                                              • u_def, v_def, w_def: The x, y, and z components of velocity, or in the case of an RZ simulation, u_def is the r velocity component, v_def is the z-component, and w_def has no meaning 
                                                                                              • nt_exp_form: Whether the neutron group fluxes have their concentrations in an exponential form. If use_exp_form is false in the GlobalParams block, this should also be false 
                                                                                              • loop_precursors: Whether the DNPs are looped back into the core through the flow inlet 
                                                                                              • transient: Whether this is a transient or time-independent simulation 
                                                                                              • eigen: Whether this is an eigenvalue problem
                                                                                              Kernels Block
                                                                                              The Kernels block is used to construct PDEs that are included in the system of equations that are solved. Each PDE has a primary variable that is being solved for, and the list of variables being solved for is defined in the Variables block shown above. There is an additional PDE solved as part of the system of PDEs for each variable defined in the Variables section. In this case, three solution variables were defined in the variable section:
                                                                                              • The group1 fast group neutron flux. 
                                                                                              • The group2 thermal group neutron flux.
                                                                                              Note that additional precursor variables are automatically defined by the Precursors block.
                                                                                              The Kernels section defines a set of "Kernels", where a "Kernel" represents a single term included in a PDE. A PDE is constructed by specifying the set of terms (or Kernels) that will be included in the PDE in the Kernels block, and by specifying which PDE the kernel is associated with. This is done by indicating which of the above three variables the kernel is associated with (i.e., group1 or group2).
                                                                                              Thus, each entry in the Kernels block specifies a term to include in one of PDEs that are solved. The type = <kernel type> parameter associated with a kernel entry identifies the term (or Kernel) that will be included in the PDE, and the variable = <primary variable> value indicates the primary solution variable (from the Variables block) associated with the term, or equivalently which PDE the term will be included in. MOOSE provides several standard kernels that can be included in a PDE. Moltres defines an additional set of kernels that are useful in modeling neutron flux and associated phenomenon in molten salt reactors. The mathematical form of each Moltres kernel can be found its corresponding documentation webpage on Moltres Syntax.
                                                                                              Kernels can be optionally restricted to specific subdomains within the model by setting block = <subdomain_names>. Note that this implies that the form of the equation that is solved may differ in different mesh regions. The equations that are modeled are represented below, followed by the input required to construct these equations. In the group1 and group2 neutron flux equations below and in the input that follows, notice that the fission kernel (CoupledFissionKernel) is only included in the fuel region ('0'), and is not included in the moderator region ('1') since there is no fuel in the moderator region. Also, the DelayedNeutronSource kernel, which contributes neutrons from the precursor group equations, is only included as part of the group1 or fast group equation.
                                                                                              Neutron Diffusion Equation for the k-Eigenvalue Problem with group1 and group2 Variables (g = 1 or 2)
                                                                                              The extra_vector_tags = eigen parameter indicates all kernels to be scaled by the  eigenvalue in this eigenvalue problem. This parameter is omitted for non-eigenvalue problems discussed in the other tutorial problems.
                                                                                              
+
                                                                                              Parameter descriptions:
                                                                                              • var_name_base: The prefix for the precursor variable names. Name suffixes are numbers, e.g. pre1, pre2, ... 
                                                                                              • block: This is a parameter ubiquitous to many MOOSE classes such as kernels and materials. By specifying a value for block the user is asking that in this case, precursors and their associated governing equations only be solved for in the fuel mesh subdomains 
                                                                                              • outlet_boundaries: The mesh boundaries from which the precursors flow out 
                                                                                              • u_def, v_def, w_def: The x, y, and z components of velocity, or in the case of an RZ simulation, u_def is the r velocity component, v_def is the z-component, and w_def has no meaning 
                                                                                              • nt_exp_form: Whether the neutron group fluxes have their concentrations in an exponential form. If use_exp_form is false in the GlobalParams block, this should also be false 
                                                                                              • loop_precursors: Whether the DNPs are looped back into the core through the flow inlet 
                                                                                              • transient: Whether this is a transient or time-independent simulation 
                                                                                              • eigen: Whether this is an eigenvalue problem
                                                                                              Kernels Block
                                                                                              The Kernels block is used to construct PDEs that are included in the system of equations that are solved. Each PDE has a primary variable that is being solved for, and the list of variables being solved for is defined in the Variables block shown above. There is an additional PDE solved as part of the system of PDEs for each variable defined in the Variables section. In this case, three solution variables were defined in the variable section:
                                                                                              • The group1 fast group neutron flux. 
                                                                                              • The group2 thermal group neutron flux.
                                                                                              Note that additional precursor variables are automatically defined by the Precursors block.
                                                                                              The Kernels section defines a set of "Kernels", where a "Kernel" represents a single term included in a PDE. A PDE is constructed by specifying the set of terms (or Kernels) that will be included in the PDE in the Kernels block, and by specifying which PDE the kernel is associated with. This is done by indicating which of the above three variables the kernel is associated with (i.e., group1 or group2).
                                                                                              Thus, each entry in the Kernels block specifies a term to include in one of PDEs that are solved. The type = <kernel type> parameter associated with a kernel entry identifies the term (or Kernel) that will be included in the PDE, and the variable = <primary variable> value indicates the primary solution variable (from the Variables block) associated with the term, or equivalently which PDE the term will be included in. MOOSE provides several standard kernels that can be included in a PDE. Moltres defines an additional set of kernels that are useful in modeling neutron flux and associated phenomenon in molten salt reactors. The mathematical form of each Moltres kernel can be found its corresponding documentation webpage on Moltres Syntax.
                                                                                              Kernels can be optionally restricted to specific subdomains within the model by setting block = <subdomain_names>. Note that this implies that the form of the equation that is solved may differ in different mesh regions. The equations that are modeled are represented below, followed by the input required to construct these equations. In the group1 and group2 neutron flux equations below and in the input that follows, notice that the fission kernel (CoupledFissionKernel) is only included in the fuel region ('0'), and is not included in the moderator region ('1') since there is no fuel in the moderator region. Also, the DelayedNeutronSource kernel, which contributes neutrons from the precursor group equations, is only included as part of the group1 or fast group equation.
                                                                                              Neutron Diffusion Equation for the k-Eigenvalue Problem with group1 and group2 Variables (g = 1 or 2)
                                                                                              The extra_vector_tags = eigen parameter indicates all kernels to be scaled by the  eigenvalue in this eigenvalue problem. This parameter is omitted for non-eigenvalue problems discussed in the other tutorial problems.
                                                                                              
 [Kernels]
   #---------------------------------------------------------------------
   # Group 1 Neutronics
@@ -120,7 +120,7 @@
     group_number = 2
   []
 []
-
                                                                                              BCs Block
                                                                                              The BCs block is very similar to the Kernels block except the boundary = <boundary_names> parameter must be specified to indicate where the boundary conditions should be applied. Documentation for the BCs can be also found on the Moltres Syntax page.
                                                                                              
+
                                                                                              BCs Block
                                                                                              The BCs block is very similar to the Kernels block except the boundary = <boundary_names> parameter must be specified to indicate where the boundary conditions should be applied. Documentation for the BCs can be also found on the Moltres Syntax page.
                                                                                              
 [BCs]
   [vacuum_group1]
     type = VacuumConcBC
@@ -133,7 +133,7 @@
     variable = group2
   []
 []
-
                                                                                              Materials Block
                                                                                              In the Materials block, we specify materials that live on a mesh subdomain. Any given subdomain can have as many material definitions as desired, so long as a property is not multiply defined. We use MoltresJsonMaterial here which is used to parse the JSON-based group constant data file.
                                                                                              
+
                                                                                              Materials Block
                                                                                              In the Materials block, we specify materials that live on a mesh subdomain. Any given subdomain can have as many material definitions as desired, so long as a property is not multiply defined. We use MoltresJsonMaterial here which is used to parse the JSON-based group constant data file.
                                                                                              
 [Materials]
   [fuel]
     type = MoltresJsonMaterial
@@ -154,7 +154,7 @@
     prop_values = ''
   []
 []
-
                                                                                              Materials within the Materials block support the following parameters:
                                                                                              • base_file: The relative/absolute path and name of the JSON file containing the macroscopic group constants that define neutron interactions in this material. 
                                                                                              • material_key: The name of the material in the JSON file that corresponds to this Material object.
                                                                                              • interp_type: The type of fitting/interpolation to be carried out on the temperature grid. Options are:
                                                                                                • spline: Cubic spline interpolation 
                                                                                                • linear: Linear spline interpolation 
                                                                                                • monotone_cubic: Monotone cubic interpolation 
                                                                                                • none: Only should be used when single values for constants are supplied   at a single temperature
                                                                                              • prop_names, prop_values: name-value pairs used to define material property values from the input file. For example, the density , thermal conductivity , and the specific heat capacity  may be defined for simulations involving a temperature variable.
                                                                                              Executioner and Preconditioning Blocks
                                                                                              The Executioner and Preconditioning blocks are essential for setting the method used to solve the system of non-linear equations created by finite element discretization of our molten salt reactor governing equations. Executioner and Preconditioning documentation can be found here and here respectively. You may also refer to our guide for basic instructions.
                                                                                              
+
                                                                                              Materials within the Materials block support the following parameters:
                                                                                              • base_file: The relative/absolute path and name of the JSON file containing the macroscopic group constants that define neutron interactions in this material. 
                                                                                              • material_key: The name of the material in the JSON file that corresponds to this Material object.
                                                                                              • interp_type: The type of fitting/interpolation to be carried out on the temperature grid. Options are:
                                                                                                • spline: Cubic spline interpolation 
                                                                                                • linear: Linear spline interpolation 
                                                                                                • monotone_cubic: Monotone cubic interpolation 
                                                                                                • none: Only should be used when single values for constants are supplied   at a single temperature
                                                                                              • prop_names, prop_values: name-value pairs used to define material property values from the input file. For example, the density , thermal conductivity , and the specific heat capacity  may be defined for simulations involving a temperature variable.
                                                                                              Executioner and Preconditioning Blocks
                                                                                              The Executioner and Preconditioning blocks are essential for setting the method used to solve the system of non-linear equations created by finite element discretization of our molten salt reactor governing equations. Executioner and Preconditioning documentation can be found here and here respectively. You may also refer to our guide for basic instructions.
                                                                                              
 [Executioner]
   type = Eigenvalue
   initial_eigenvalue = 1
@@ -169,7 +169,7 @@
 
   line_search = none
 []
-
                                                                                              Postprocessors Block
                                                                                              A PostProcessor computes a single scalar value during the simulations. General postprocessor documentation can be found here. 
                                                                                              k_eff retrieves the real part of the computed eigenvalue which is taken to be the  multiplication factor. The bnorm, tot_fissions, and powernorm postprocessor objects calculate the total number of fission neutrons, fission interactions, and fission heat, respectively. The bnorm parameter is required by the Eigenvalue executioner as an estimate for  in each iteration. The other two may be used to normalize the flux solution at the end of the calculation through the normalization and normal_factor parameters in the Executioner block. The rest of the postprocessors calculate the integral sum, diff, or maximum values of the group1 and group2 flux variables.
                                                                                              
+
                                                                                              Postprocessors Block
                                                                                              A PostProcessor computes a single scalar value during the simulations. General postprocessor documentation can be found here. 
                                                                                              k_eff retrieves the real part of the computed eigenvalue which is taken to be the  multiplication factor. The bnorm, tot_fissions, and powernorm postprocessor objects calculate the total number of fission neutrons, fission interactions, and fission heat, respectively. The bnorm parameter is required by the Eigenvalue executioner as an estimate for  in each iteration. The other two may be used to normalize the flux solution at the end of the calculation through the normalization and normal_factor parameters in the Executioner block. The rest of the postprocessors calculate the integral sum, diff, or maximum values of the group1 and group2 flux variables.
                                                                                              
 [Postprocessors]
   [k_eff]
     type = VectorPostprocessorComponent
@@ -222,7 +222,7 @@
     execute_on = 'linear timestep_end'
   []
 []
-
                                                                                              Outputs Block
                                                                                              In the Outputs block, we can control the settings for various data output formats. Outputs documentation is here. In this input file, the Exodus and CSV output formats are enabled with default settings associated with each output type. print_graph prints various computational performance information in the console (e.g., time taken in each section of the simulation). print_linear_residuals prints all linear residual values during the simulation, which may be desired when running test runs.
                                                                                              
+
                                                                                              Outputs Block
                                                                                              In the Outputs block, we can control the settings for various data output formats. Outputs documentation is here. In this input file, the Exodus and CSV output formats are enabled with default settings associated with each output type. print_graph prints various computational performance information in the console (e.g., time taken in each section of the simulation). print_linear_residuals prints all linear residual values during the simulation, which may be desired when running test runs.
                                                                                              
 [Outputs]
   print_graph = true
   print_linear_residuals = true
@@ -233,8 +233,8 @@
     type = CSV
   []
 []
-
                                                                                              Debug Block
                                                                                              This parameter tells Moltres to print the variable residual norms during the non-linear solve. Residual information is useful for debugging convergence issues by identifying which variable is exhibiting slow or no convergence behavior.
                                                                                              
+
                                                                                              Debug Block
                                                                                              This parameter tells Moltres to print the variable residual norms during the non-linear solve. Residual information is useful for debugging convergence issues by identifying which variable is exhibiting slow or no convergence behavior.
                                                                                              
 [Debug]
   show_var_residual_norms = true
 []
-
                                                                                              
\ No newline at end of file
+
                                                                                              \ No newline at end of file diff --git a/getting_started/installation.html b/getting_started/installation.html index ad11c4235..b2c878dc4 100644 --- a/getting_started/installation.html +++ b/getting_started/installation.html @@ -1,4 +1,4 @@ -Install Moltres | Moltres

                                                                                              Install Moltres

                                                                                              1. Install the Conda MOOSE Environment

                                                                                              Moltres relies on the MOOSE framework. We suggest that users install the latest MOOSE environment using Conda packages by following the instructions in the "Conda MOOSE Environment" and "Install MOOSE" sections of the MOOSE installation guide. We cannot guarantee compatibility with older MOOSE builds and their corresponding Conda environments. The latest MOOSE Conda environment is usually compatible unless the MOOSE team introduces significant changes to the dependencies. We encourage you to post a GitHub issue if you encounter compatibility issues so that we can rectify it as soon as possible.

                                                                                              2. Clone Moltres

                                                                                              The Moltres GitHub repository already contains MOOSE and Squirrel as Git submodules, therefore there is no need to clone and compile MOOSE separately.

                                                                                              Abiding by MOOSE's instructions for setting up a projects directory for MOOSE-related content, users can clone Moltres and download MOOSE as a submodule by running the commands:

                                                                                              
+Install Moltres | Moltres
                                                                                              Install Moltres
                                                                                              1. Install the Conda MOOSE Environment
                                                                                              Moltres relies on the MOOSE framework. We suggest that users install the latest MOOSE environment using Conda packages by following the instructions in the "Conda MOOSE Environment" and "Install MOOSE" sections of the MOOSE installation guide. We cannot guarantee compatibility with older MOOSE builds and their corresponding Conda environments. The latest MOOSE Conda environment is usually compatible unless the MOOSE team introduces significant changes to the dependencies. We encourage you to post a GitHub issue if you encounter compatibility issues so that we can rectify it as soon as possible.
                                                                                              2. Clone Moltres
                                                                                              The Moltres GitHub repository already contains MOOSE and Squirrel as Git submodules, therefore there is no need to clone and compile MOOSE separately. 
                                                                                              Abiding by MOOSE's instructions for setting up a projects directory for MOOSE-related content, users can clone Moltres and download MOOSE as a submodule by running the commands:
                                                                                              
 mkdir ~/projects
 cd ~/projects
 git clone https://github.com/arfc/moltres.git
@@ -6,14 +6,14 @@
 git checkout master
 git submodule init
 git submodule update
-
                                                                                              3. Compile and Test Moltres
                                                                                              Before proceeding with this step, check that the Conda MOOSE environment is activated in your current terminal. This is achieved by running the following command every time you open a new terminal:
                                                                                              
+
                                                                                              3. Compile and Test Moltres
                                                                                              Before proceeding with this step, check that the Conda MOOSE environment is activated in your current terminal. This is achieved by running the following command every time you open a new terminal:
                                                                                              
 conda activate moose
 
                                                                                              Finally, compile Moltres and run tests to check your installation using the following commands:
                                                                                              
 make -j8
 ./run_tests -j8
 
                                                                                              commentnote
                                                                                              You may also compile a debug version of Moltres by running METHOD=dbg make
--j8. Note that you should replace 8 with the number of processors available on your machine.
                                                                                              If you encounter any problems with installation, please post on our GitHub Discussions page along with the full error message so that we can help you troubleshoot your installation.
                                                                                              4. Running Moltres Simulations
                                                                                              If you have successfully completed the previous step, you should have a moltres-opt executable in the ~\projects\moltres directory. To run a Moltres input file, use the following command:
                                                                                              
+-j8. Note that you should replace 8 with the number of processors available on your machine.
                                                                                              If you encounter any problems with installation, please post on our GitHub Discussions page along with the full error message so that we can help you troubleshoot your installation.

                                                                                              4. Running Moltres Simulations

                                                                                              If you have successfully completed the previous step, you should have a moltres-opt executable in the ~\projects\moltres directory. To run a Moltres input file, use the following command:

                                                                                              
 ~/projects/moltres/moltres-opt -i input-file.i

                                                                                              To run an input file on more than one processor, use the mpirun command as follows:

                                                                                              
 mpirun -n 8 ~/projects/moltres/moltres-opt -i input-file.i
-

                                                                                              As above, replace 8 with the number of processors available on your machine.

                                                                                              \ No newline at end of file +

                                                                                              As above, replace 8 with the number of processors available on your machine.

                                                                                              \ No newline at end of file diff --git a/getting_started/moltres_xs.html b/getting_started/moltres_xs.html index 88f0c058e..c1dc7dd89 100644 --- a/getting_started/moltres_xs.html +++ b/getting_started/moltres_xs.html @@ -1,4 +1,4 @@ -Group Constant File Generation With | Moltres

                                                                                              Group Constant File Generation With moltres_xs.py

                                                                                              Example problem: Godiva Sphere

                                                                                              In this tutorial, we demonstrate how to use OpenMC to generate group constants for Moltres using moltres_xs.py.

                                                                                              The relevant files for this tutorial may be found in the godiva tutorial directory. To run these input files and subsequent group constant generation scripts, the user must install OpenMC version 0.13.2 or later.

                                                                                              Step 1: Generating Group Constants with OpenMC

                                                                                              In this directory, there are 2 OpenMC input files for 900K and 1200K simulations: godiva_openmc_900.py and godiva_openmc_1200.py. Unlike Scale or Serpent, OpenMC does not have a notion of branches to generate group constants for different temperatures and burnups. Thus, separate input files for different temperatures is required.

                                                                                              The user must include the openmc_xs.generate_openmc_tallies_xml() function in the OpenMC input file to generate a domain_dict. The function sets up the OpenMC tallies required for the group constant generation. This is necessary because unlike Serpent, OpenMC does not generate all the group constant data with any simulation, the user must specify what they want. The user may define domains as either openmc.Material or openmc.Cell.

                                                                                              For this tutorial, we also provide the OpenMC output files obtained after running the input files: statepoint_900_openmc.100.h5, statepoint_1200_openmc.100.h5, summary_900.h5, and summary_1200.h5. Each OpenMC simulation generates a statepoint and summary file. Both output files are required for the group constant generation.

                                                                                              Step 2: Parsing OpenMC Output Files with moltres_xs.py

                                                                                              godiva_openmc.inp is the input file that informs moltres_xs.py how to parse the various OpenMC output files to generate Moltres group constants. The structure of the input file is as follows:

                                                                                              
+Group Constant File Generation With | Moltres
                                                                                              Group Constant File Generation With moltres_xs.py
                                                                                              Example problem: Godiva Sphere
                                                                                              In this tutorial, we demonstrate how to use OpenMC to generate group constants for Moltres using moltres_xs.py.
                                                                                              The relevant files for this tutorial may be found in the godiva tutorial directory. To run these input files and subsequent group constant generation scripts, the user must install OpenMC version 0.13.2 or later.
                                                                                              Step 1: Generating Group Constants with OpenMC
                                                                                              In this directory, there are 2 OpenMC input files for 900K and 1200K simulations: godiva_openmc_900.py and godiva_openmc_1200.py. Unlike Scale or Serpent, OpenMC does not have a notion of branches to generate group constants for different temperatures and burnups. Thus, separate input files for different temperatures is required.
                                                                                              The user must include the openmc_xs.generate_openmc_tallies_xml() function in the OpenMC input file to generate a domain_dict. The function sets up the OpenMC tallies required for the group constant generation. This is necessary because unlike Serpent, OpenMC does not generate all the group constant data with any simulation, the user must specify what they want. The user may define domains as either openmc.Material or openmc.Cell.
                                                                                              For this tutorial, we also provide the OpenMC output files obtained after running the input files: statepoint_900_openmc.100.h5, statepoint_1200_openmc.100.h5, summary_900.h5, and summary_1200.h5. Each OpenMC simulation generates a statepoint and summary file. Both output files are required for the group constant generation.
                                                                                              Step 2: Parsing OpenMC Output Files with moltres_xs.py
                                                                                              godiva_openmc.inp is the input file that informs moltres_xs.py how to parse the various OpenMC output files to generate Moltres group constants. The structure of the input file is as follows:
                                                                                              
 [TITLE]
   *name of output json file*
 
@@ -13,8 +13,8 @@
 [FILES]
   *number of files*
   *statepoint file name* *openmc* *openmc input file* *summary file*
-
                                                                                              For OpenMC, since we do not utilize the burnup and branch indexes, users must indicate both index values as "1" so that moltres_xs.py correctly parses the input file. For OpenMC, we also add additional openmc input files and summary files. The universe index must correspond to the material or cell id defined in the OpenMC input file.
                                                                                              To generate the Moltres group constants, the user runs: ` python ../../python/moltres_xs.py godiva_openmc.inp ` This will output godiva_openmc.json containing the Moltres group constants. An example of this output file can be found in ../../python/test/gold/godiva.json.
                                                                                              OpenMC Group Constant Generation
                                                                                              This table outlines the OpenMC methods used by moltres_xs.py to calculate the group constants for Moltres.
                                                                                              Group ConstantDescriptionOpenMC Tally UsedUnits
                                                                                              BETA_EFFDelayed neutron fractionmgxs.Beta()-
                                                                                              CHI_TFission spectrum (total)mgxs.Chi()-
                                                                                              CHI_PFission spectrum (prompt neutrons)mgxs.Chi(prompt=True)-
                                                                                              CHI_DFission spectrum (delayed neutrons)mgxs.ChiDelayed()-
                                                                                              DECAY_CONSTANTDecay rate for delayed neutron precursorsmgxs.DecayRate()1/s
                                                                                              DIFFCOEFDiffusion coefficient multi-group cross sectionmgxs.DiffusionCoefficient()cm
                                                                                              FISSEAverage deposited fission energymgxs.KappaFissionXS() / mgxs.FissionXS()MeV
                                                                                              FISSXSFission cross sectionmgxs.FissionXS()1/cm
                                                                                              GTRANSFXSScattering production XS Matrixmgxs.ScatterProbabilityMatrix() * mgxs.ScatterXS()1/cm
                                                                                              NSFFission neutron production cross sectionnu-fission / flux1/cm
                                                                                              RECIPVELInverse neutron speedmgxs.InverseVelocity()s/cm
                                                                                              REMXSRemoval cross section (out scatter + absorption)mgxs.ScatterProbabilityMatrix() *  mgxs.ScatterXS() + mgxs.AbsorptionXS()1/cm
                                                                                              Serpent Comparison
                                                                                              We cross verified the group constants generated by OpenMC with group constants generated by Serpent. godiva_serpent and godiva_serpent_res.m are the Serpent input and output files for the Godiva sphere. godiva_serpent.inp generates the group constants with moltres_xs.py. Note the minor differences between godiva_openmc.inp and godiva_serpent.inp arising from the use of branch and coef cards to set up various reactor states at various temperatures in Serpent. Serpent condenses multi-temperature group constant data from the various branches into one *_res.m output file.
                                                                                              The only difference in syntax format for Serpent-based *.inp files lies in the [FILES] section as follows:
                                                                                              
+
                                                                                              For OpenMC, since we do not utilize the burnup and branch indexes, users must indicate both index values as "1" so that moltres_xs.py correctly parses the input file. For OpenMC, we also add additional openmc input files and summary files. The universe index must correspond to the material or cell id defined in the OpenMC input file.
                                                                                              To generate the Moltres group constants, the user runs: ` python ../../python/moltres_xs.py godiva_openmc.inp ` This will output godiva_openmc.json containing the Moltres group constants. An example of this output file can be found in ../../python/test/gold/godiva.json.
                                                                                              OpenMC Group Constant Generation
                                                                                              This table outlines the OpenMC methods used by moltres_xs.py to calculate the group constants for Moltres.
                                                                                              Group ConstantDescriptionOpenMC Tally UsedUnits
                                                                                              BETA_EFFDelayed neutron fractionmgxs.Beta()-
                                                                                              CHI_TFission spectrum (total)mgxs.Chi()-
                                                                                              CHI_PFission spectrum (prompt neutrons)mgxs.Chi(prompt=True)-
                                                                                              CHI_DFission spectrum (delayed neutrons)mgxs.ChiDelayed()-
                                                                                              DECAY_CONSTANTDecay rate for delayed neutron precursorsmgxs.DecayRate()1/s
                                                                                              DIFFCOEFDiffusion coefficient multi-group cross sectionmgxs.DiffusionCoefficient()cm
                                                                                              FISSEAverage deposited fission energymgxs.KappaFissionXS() / mgxs.FissionXS()MeV
                                                                                              FISSXSFission cross sectionmgxs.FissionXS()1/cm
                                                                                              GTRANSFXSScattering production XS Matrixmgxs.ScatterProbabilityMatrix() * mgxs.ScatterXS()1/cm
                                                                                              NSFFission neutron production cross sectionnu-fission / flux1/cm
                                                                                              RECIPVELInverse neutron speedmgxs.InverseVelocity()s/cm
                                                                                              REMXSRemoval cross section (out scatter + absorption)mgxs.ScatterProbabilityMatrix() *  mgxs.ScatterXS() + mgxs.AbsorptionXS()1/cm
                                                                                              Serpent Comparison
                                                                                              We cross verified the group constants generated by OpenMC with group constants generated by Serpent. godiva_serpent and godiva_serpent_res.m are the Serpent input and output files for the Godiva sphere. godiva_serpent.inp generates the group constants with moltres_xs.py. Note the minor differences between godiva_openmc.inp and godiva_serpent.inp arising from the use of branch and coef cards to set up various reactor states at various temperatures in Serpent. Serpent condenses multi-temperature group constant data from the various branches into one *_res.m output file.
                                                                                              The only difference in syntax format for Serpent-based *.inp files lies in the [FILES] section as follows:
                                                                                              
 [FILES]
   *number of files*
   *serpent _res.m file name* *serpent*
-
                                                                                              The group constant values generated by both Serpent and OpenMC are similar in values and orders of magnitude. The only notable difference is in the FISSE group constant value. Serpent outputs FISSE values of ~193 MeV, while OpenMC outputs FISSE values of ~202 MeV. A possible reason for this discrepancy is that Serpent includes neutrino energies while OpenMC does not.
                                                                                              \ No newline at end of file +

                                                                                              The group constant values generated by both Serpent and OpenMC are similar in values and orders of magnitude. The only notable difference is in the FISSE group constant value. Serpent outputs FISSE values of ~193 MeV, while OpenMC outputs FISSE values of ~202 MeV. A possible reason for this discrepancy is that Serpent includes neutrino energies while OpenMC does not.

                                                                                              \ No newline at end of file diff --git a/getting_started/recommended.html b/getting_started/recommended.html index adbe4662c..a00d72dbf 100644 --- a/getting_started/recommended.html +++ b/getting_started/recommended.html @@ -1,18 +1,18 @@ -Recommended Executioner and Preconditioning Settings | Moltres

                                                                                              Recommended Executioner and Preconditioning Settings

                                                                                              This page provides recommended Executioner and Preconditioning settings for new Moltres users who already have basic proficiency with MOOSE. The following sections provide recommendations on the solve type, automatic scaling, time integration scheme, and preconditioning settings.

                                                                                              Moltres, like all MOOSE-based apps, rely on PETSc for preconditioning. Refer to MOOSE's documentation here for basic information on preconditioning in MOOSE. You may also refer to the example input file here for an introduction to the Moltres input file format.

                                                                                              Solve Type

                                                                                              Previous experiences have shown that Moltres simulations usually require the NEWTON solve type with all off-diagonal Jacobian entries enabled because reactor neutronics problems are very non-linear from the strong coupling between the neutron group flux and delayed neutron precursor concentration variables. Users may use these settings by setting solve_type = NEWTON and full = true in the Executioner and Preconditioning blocks, respectively, in the input file.

                                                                                              Automatic Scaling

                                                                                              Relevant variables in a Moltres simulation include neutron group fluxes, delayed neutron precursor concentrations, temperature, and velocity components. These variables differ significantly in magnitude, especially between the neutronics and thermal-hydraulics variables. We recommend applying scaling factors to the variables so that: 1) final residual norm values are on similar orders of magnitudes to ensure that every variable is converged at the end of each step, and 2) the Jacobian is well-conditioned.

                                                                                              Users may manually set the scaling factor for each variable using the scaling parameter when defining the variable. Alternatively, we recommend using the automatic_scaling feature from MOOSE. This feature automatically calculates the appropriate scaling factor for each variable.

                                                                                              We recommend using the following parameters to set automatic scaling in the Executioner block.

                                                                                              
+Recommended Executioner and Preconditioning Settings | Moltres
                                                                                              Recommended Executioner and Preconditioning Settings
                                                                                              This page provides recommended Executioner and Preconditioning settings for new Moltres users who already have basic proficiency with MOOSE. The following sections provide recommendations on the solve type, automatic scaling, time integration scheme, and preconditioning settings.
                                                                                              Moltres, like all MOOSE-based apps, rely on PETSc for preconditioning. Refer to MOOSE's documentation here for basic information on preconditioning in MOOSE. You may also refer to the example input file here for an introduction to the Moltres input file format.
                                                                                              Solve Type
                                                                                              Previous experiences have shown that Moltres simulations usually require the NEWTON solve type with all off-diagonal Jacobian entries enabled because reactor neutronics problems are very non-linear from the strong coupling between the neutron group flux and delayed neutron precursor concentration variables. Users may use these settings by setting solve_type = NEWTON and full = true in the Executioner and Preconditioning blocks, respectively, in the input file.
                                                                                              Automatic Scaling
                                                                                              Relevant variables in a Moltres simulation include neutron group fluxes, delayed neutron precursor concentrations, temperature, and velocity components. These variables differ significantly in magnitude, especially between the neutronics and thermal-hydraulics variables. We recommend applying scaling factors to the variables so that: 1) final residual norm values are on similar orders of magnitudes to ensure that every variable is converged at the end of each step, and 2) the Jacobian is well-conditioned.
                                                                                              Users may manually set the scaling factor for each variable using the scaling parameter when defining the variable. Alternatively, we recommend using the automatic_scaling feature from MOOSE. This feature automatically calculates the appropriate scaling factor for each variable.
                                                                                              We recommend using the following parameters to set automatic scaling in the Executioner block.
                                                                                              
 automatic_scaling = true
 resid_vs_jac_scaling_param = 0.2
 scaling_group_variables = 'group1 group2; pre1 pre2 pre3 pre4 pre5 pre6 pre7 pre8; temp'
 compute_scaling_once = false
 off_diagonals_in_auto_scaling = true
-
                                                                                              • automatic_scaling: Turns on automatic scaling. 
                                                                                              • resid_vs_jac_scaling_param: Determines whether the scaling factor is based on the residual or Jacobian entries; 0 corresponds to pure Jacobian scaling and 1 corresponds to pure residual scaling while all values in between correspond to hybrid scaling. The ideal value for this parameter depends heavily on the type of simulation. Most Moltres simulations run faster with this parameter at 0.1~0.3. 
                                                                                              • scaling_group_variables: Groups variables which share the same scaling factor. The MOOSE team recommends grouping variables derived from the same physics for stability. 
                                                                                              • compute_scaling_once: Whether Moltres calculates the scaling factors once at the beginning of the simulation (true) or at the beginning of every timestep (false). 
                                                                                              • off_diagonals_in_auto_scaling: Whether to consider off-diagonals when determining automatic scaling factors.
                                                                                              Time Integration Scheme
                                                                                              We recommend using either ImplicitEuler or BDF2 based on the first and second order backward differentiation formula time integration schemes. The BDF2 scheme is more accurate (higher-order) and has a superior convergence rate.
                                                                                              All multi-stage time integration schemes from MOOSE are incompatible with Moltres simulations.
                                                                                              To set the time integration scheme, include the following line in the Executioner block.
                                                                                              
+
                                                                                              • automatic_scaling: Turns on automatic scaling. 
                                                                                              • resid_vs_jac_scaling_param: Determines whether the scaling factor is based on the residual or Jacobian entries; 0 corresponds to pure Jacobian scaling and 1 corresponds to pure residual scaling while all values in between correspond to hybrid scaling. The ideal value for this parameter depends heavily on the type of simulation. Most Moltres simulations run faster with this parameter at 0.1~0.3. 
                                                                                              • scaling_group_variables: Groups variables which share the same scaling factor. The MOOSE team recommends grouping variables derived from the same physics for stability. 
                                                                                              • compute_scaling_once: Whether Moltres calculates the scaling factors once at the beginning of the simulation (true) or at the beginning of every timestep (false). 
                                                                                              • off_diagonals_in_auto_scaling: Whether to consider off-diagonals when determining automatic scaling factors.
                                                                                              Time Integration Scheme
                                                                                              We recommend using either ImplicitEuler or BDF2 based on the first and second order backward differentiation formula time integration schemes. The BDF2 scheme is more accurate (higher-order) and has a superior convergence rate.
                                                                                              All multi-stage time integration schemes from MOOSE are incompatible with Moltres simulations.
                                                                                              To set the time integration scheme, include the following line in the Executioner block.
                                                                                              
 scheme = bdf2    # or implicit-euler for ImplicitEuler
-
                                                                                              Preconditioning
                                                                                              Our discussions on preconditioning here relate to the NEWTON solve type which relies on PETSc routines to solve the system of linear equations in each Newton iteration.
                                                                                              Users can pick their preferred linear system solver and the associated settings in PETSc for their problem through the petsc_options_iname and petsc_options_value parameters in the Executioner block.
                                                                                              LU
                                                                                              The most reliable "preconditioner" type for Moltres simulations is lu. lu is actually a direct solver based on LU factorization. As a direct solver, it is very accurate as long as the user provides the correct Jacobian formulations in their kernels. PETSc's default lu implementation is serial and thus, it does not scale over multiple processors. lu requires the superlu_dist parallel library to be effective over multiple processors. However, superlu_dist does not scale as well as the asm option in the next section. As such, we recommend only using superlu_dist for smaller problems (<100k DOFs).
                                                                                              lu on a single process:
                                                                                              
+
                                                                                              Preconditioning
                                                                                              Our discussions on preconditioning here relate to the NEWTON solve type which relies on PETSc routines to solve the system of linear equations in each Newton iteration.
                                                                                              Users can pick their preferred linear system solver and the associated settings in PETSc for their problem through the petsc_options_iname and petsc_options_value parameters in the Executioner block.
                                                                                              LU
                                                                                              The most reliable "preconditioner" type for Moltres simulations is lu. lu is actually a direct solver based on LU factorization. As a direct solver, it is very accurate as long as the user provides the correct Jacobian formulations in their kernels. PETSc's default lu implementation is serial and thus, it does not scale over multiple processors. lu requires the superlu_dist parallel library to be effective over multiple processors. However, superlu_dist does not scale as well as the asm option in the next section. As such, we recommend only using superlu_dist for smaller problems (<100k DOFs).
                                                                                              lu on a single process:
                                                                                              
 petsc_options_iname = '-pc_type -pc_factor_shift_type'
 petsc_options_value = 'lu       NONZERO'
 
                                                                                              lu with superlu_dist on multiple MPI processes:
                                                                                              
 petsc_options_iname = '-pc_type -pc_factor_shift_type -pc_factor_mat_solver_type'
 petsc_options_value = 'lu       NONZERO               superlu_dist'
-
                                                                                              ASM
                                                                                              Direct solvers like lu do not scale well with problem size. Iterative methods are recommended for large problems. The best performing preconditioner type for large problems in Moltres is asm. asm is based on the Additive Schwarz Method (ASM) for generating preconditioners for the GMRES iterative method. Moltres simulations also require a strong subsolver like lu for solving each subdomain.
                                                                                              asm on multiple MPI processes:
                                                                                              
+
                                                                                              ASM
                                                                                              Direct solvers like lu do not scale well with problem size. Iterative methods are recommended for large problems. The best performing preconditioner type for large problems in Moltres is asm. asm is based on the Additive Schwarz Method (ASM) for generating preconditioners for the GMRES iterative method. Moltres simulations also require a strong subsolver like lu for solving each subdomain.
                                                                                              asm on multiple MPI processes:
                                                                                              
 petsc_options_iname = '-pc_type -sub_pc_type -sub_pc_factor_shift_type -pc_asm_overlap -ksp_gmres_restart'
 petsc_options_value = 'asm      lu           NONZERO                   1               200'
-
                                                                                              Preconditioner Recommendations
                                                                                              Here are the recommended preconditioner settings for the following problem sizes:
                                                                                              Small problems (<10k DOFs)
                                                                                              • Number of MPI processes: 1-4 
                                                                                              • Preconditioner options: - lu on 1 process - lu with superlu_dist on multiple processes - asm on multiple processes
                                                                                              Medium problems (<100k DOFs)
                                                                                              • Number of MPI processes: 4-16 
                                                                                              • Preconditioner options: - lu with superlu_dist on multiple processes - asm on multiple processes
                                                                                              Large problems (>100k DOFs)
                                                                                              • Number of MPI processes: Up to 1 MPI process per 10k DOFs 
                                                                                              • Preconditioner options: - asm on multiple processes
                                                                                              General tips
                                                                                              • lu is faster than asm for small problems. 
                                                                                              • l_tol = 1e-5 is the default linear tolerance value. l_tol can be raised to 1e-4 or 1e-3 for large problems without much impact on performance if the problem requires too many linear iterations (>400) on every nonlinear iteration. 
                                                                                              • Automatic scaling may not scale correctly on the first timestep when restarting a Moltres simulation using MOOSE's Restart functionality. Thus, the simulation may fail to converge on the first timestep. 
                                                                                              • When using asm, the number of linear iterations required per nonlinear iteration scales linearly with the number of subdomains (i.e. number of MPI processes). As such, increasing the number of processors beyond a certain threshold increases the solve time.
                                                                                              
\ No newline at end of file
+

                                                                                              Preconditioner Recommendations

                                                                                              Here are the recommended preconditioner settings for the following problem sizes:

                                                                                              Small problems (<10k DOFs)

                                                                                              • Number of MPI processes: 1-4

                                                                                              • Preconditioner options: - lu on 1 process - lu with superlu_dist on multiple processes - asm on multiple processes

                                                                                              Medium problems (<100k DOFs)

                                                                                              • Number of MPI processes: 4-16

                                                                                              • Preconditioner options: - lu with superlu_dist on multiple processes - asm on multiple processes

                                                                                              Large problems (>100k DOFs)

                                                                                              • Number of MPI processes: Up to 1 MPI process per 10k DOFs

                                                                                              • Preconditioner options: - asm on multiple processes

                                                                                              General tips

                                                                                              • lu is faster than asm for small problems.

                                                                                              • l_tol = 1e-5 is the default linear tolerance value. l_tol can be raised to 1e-4 or 1e-3 for large problems without much impact on performance if the problem requires too many linear iterations (>400) on every nonlinear iteration.

                                                                                              • Automatic scaling may not scale correctly on the first timestep when restarting a Moltres simulation using MOOSE's Restart functionality. Thus, the simulation may fail to converge on the first timestep.

                                                                                              • When using asm, the number of linear iterations required per nonlinear iteration scales linearly with the number of subdomains (i.e. number of MPI processes). As such, increasing the number of processors beyond a certain threshold increases the solve time.

                                                                                              \ No newline at end of file diff --git a/getting_started/sss2_gc.html b/getting_started/sss2_gc.html index 767195bbb..03c7443f3 100644 --- a/getting_started/sss2_gc.html +++ b/getting_started/sss2_gc.html @@ -1,3 +1,3 @@ -Group Constant File Generation With | Moltres

                                                                                              Group Constant File Generation With extractSerpent2GCs.py

                                                                                              Example problem: Two-region MSRE model

                                                                                              Here, group constants are taken from an example Serpent output using PyNE. These will be used to generate text-based group constant files using extractSerpent2GCs.py. The relevant files for this tutorial may be found in the MSRE_group_constants tutorial directory.

                                                                                              Moltres is not a spatially homogenized diffusion code. MOOSE is made for running big, intense problems, using modern HPC. Because there is no desire to homogenize spatially here, the materials that the user would like used in Moltres should each fill their own infinite universe. Then, this universe should have its group constants generated using the set gcu <material universe numbers> option in Serpent 2.

                                                                                              It's important that universe 0, the main universe, is not included. Serpent takes tallies for group constants in the first universe it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the serpent forum).

                                                                                              Step 1: Generating Group Constants with Serpent 2

                                                                                              In this directory, we provide a Serpent input file for simulating ORNL's Molten Salt Reactor Experiment, documented largely on websites like this.

                                                                                              For group constant generation, Cole Gentry found that a 4 group structure with three thermal groups and one fast group works well in the graphite moderated FHR. There is also an available recommended 13-group structure commented out in the gentryGroups.serp file The PDF of these findings can be found here.

                                                                                              The "fuel" file contains "cards" (a relic term referring to the fortran-dominated reactor physics ages of yore) that will generate group constants at a few temperatures, and likewise for the "moder" file. Like a cooking show, we have prepared the important results for you in the fuel.coe and moder.coe files, which get parsed by serpentTools in the extractSerpent2GCs script. serpentTools is a suite of parsers designed by GATech for parsing SERPENT output files. More information can be found at here.

                                                                                              Step 2: Parsing Serpent 2 Output Files with extractSerpent2GCs.py

                                                                                              The command to run in order to generate the Moltres-compatible group constants is:

                                                                                              
+Group Constant File Generation With | Moltres
                                                                                              Group Constant File Generation With extractSerpent2GCs.py
                                                                                              Example problem: Two-region MSRE model
                                                                                              Here, group constants are taken from an example Serpent output using PyNE. These will be used to generate text-based group constant files using extractSerpent2GCs.py. The relevant files for this tutorial may be found in the MSRE_group_constants tutorial directory.
                                                                                              Moltres is not a spatially homogenized diffusion code. MOOSE is made for running big, intense problems, using modern HPC. Because there is no desire to homogenize spatially here, the materials that the user would like used in Moltres should each fill their own infinite universe. Then, this universe should have its group constants generated using the set gcu <material universe numbers> option in Serpent 2.
                                                                                              It's important that universe 0, the main universe, is not included. Serpent takes tallies for group constants in the first universe it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the serpent forum).
                                                                                              Step 1: Generating Group Constants with Serpent 2
                                                                                              In this directory, we provide a Serpent input file for simulating ORNL's Molten Salt Reactor Experiment, documented largely on websites like this.
                                                                                              For group constant generation, Cole Gentry found that a 4 group structure with three thermal groups and one fast group works well in the graphite moderated FHR. There is also an available recommended 13-group structure commented out in the gentryGroups.serp file  The PDF of these findings can be found here.
                                                                                              The "fuel" file contains "cards" (a relic term referring to the fortran-dominated reactor physics ages of yore) that will generate group constants at a few temperatures, and likewise for the "moder" file. Like a cooking show, we have prepared the important results for you in the fuel.coe and moder.coe files, which get parsed by serpentTools in the extractSerpent2GCs script. serpentTools is a suite of parsers designed by GATech for parsing SERPENT output files. More information can be found at here.
                                                                                              Step 2: Parsing Serpent 2 Output Files with extractSerpent2GCs.py
                                                                                              The command to run in order to generate the Moltres-compatible group constants is:
                                                                                              
 $MOLTRES/python/extractSerpent2GCs.py MSREProperties msre_gentry_4g tempMapping.txt secBranch.txt universeMapping.txt
-
                                                                                              where $MOLTRES is an environment variable leading to the install location of Moltres. An alternative would be to just add the $MOLTRES/python directory to your path.
                                                                                              The input syntax requires a directory name you'd like to create, a file base name that Moltres will look at, a file that maps primary branch names to temperatures, a file that lists the secondary branch names, and lastly a file that maps universe numbers from Serpent to material names. Group constants will be extracted for all materials listed in the last file.
                                                                                              The secBranch.txt file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step. 
                                                                                              
\ No newline at end of file
+

                                                                                              where $MOLTRES is an environment variable leading to the install location of Moltres. An alternative would be to just add the $MOLTRES/python directory to your path.

                                                                                              The input syntax requires a directory name you'd like to create, a file base name that Moltres will look at, a file that maps primary branch names to temperatures, a file that lists the secondary branch names, and lastly a file that maps universe numbers from Serpent to material names. Group constants will be extracted for all materials listed in the last file.

                                                                                              The secBranch.txt file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step.

                                                                                              \ No newline at end of file diff --git a/getting_started/theory.html b/getting_started/theory.html index 9eec3e0ff..84523e455 100644 --- a/getting_started/theory.html +++ b/getting_started/theory.html @@ -1,7 +1,7 @@ -Theory and Methodology | Moltres

                                                                                              Theory and Methodology

                                                                                              The two-step procedure is a common approach for multiphysics full-core nuclear reactor analysis. These steps are:

                                                                                              Step 1: Generate neutron group constant data with a lattice or full-core reactor model on a high-fidelity, continuous/fine-energy neutronics software at various reactor states.

                                                                                              Step 2: Use an intermediate-fidelity, computationally cheaper neutronics software with the neutron group constant data to perform multiphysics reactor analysis.

                                                                                              Moltres falls under Step 2 of the two-step procedure. Moltres solves the conventional multigroup neutron diffusion and delayed neutron precursor equations. The precursor equations include precursor drift terms to account for precursor movement under molten salt flow. Moltres is built on the MOOSE finite element framework, enabling highly flexible and scalable reactor simulations.

                                                                                              Multigroup Neutron Diffusion

                                                                                              More information to be added in future.

                                                                                              Heat Transfer and Fluid Flow

                                                                                              Moltres compiles with the MOOSE Navier-Stokes and Heat Transfer modules for flow modeling capabilities by default. Moltres couples with these modules natively because they are all built on the MOOSE framework.

                                                                                              Past work with Moltres have modeled incompressible salt flow and temperature advection-diffusion with the INS or INSAD implementations of the Navier-Stokes equations (Peterson et al., 2018). Coupling with the compressible or finite volume implementations within the Navier-Stokes module are likely possible, but have not been demonstrated yet.

                                                                                              For turbulence modeling, Moltres has a Spalart-Allmaras (SA) turbulence model (Spalart and Allmaras, 1992) implementation with streamline-upwind Petrov-Galerkin (SUPG) stabilization. On balance the SA model is a complete (does not require prior knowledge of the actual turbulence behavior) and computationally efficient turbulence model for approximating wall-bounded turbulent flows. The SA model implementation in Moltres is compatible with the INSAD implementation only. Additionally, Moltres contains turbulent diffusion physics kernels for temperature and the delayed neutron precursors.

                                                                                              The SA model in Moltres follows the (SA-noft2-R) implementation as described on the NASA Turbulence Modeling Resource website. The term is togglable using the use_ft2_term input parameter (false by default). Moltres' implementation solves for the modified dynamic viscosity which can be easily obtained using to convert to as follows:

                                                                                              (1)

                                                                                              where

                                                                                              and the constants are:

                                                                                              We performed simple verification and validation tests of the SA model in Moltres using reference problems for channel, pipe, and backward-facing step flow. The Moltres test dataset is available on Zenodo. The following subsections show plots comparing results from Moltres to reference data from literature.

                                                                                              Turbulent Channel Flow Verification Test

                                                                                              The channel flow test is based on the direct numerical simulation (DNS) of turbulent channel flow with by Moser et al. (1999). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/channel-flow/.

                                                                                              Figure 1: Normalized velocity distribution across the channel.

                                                                                              Figure 2: Dimensionless velocity vs dimensionless wall distance.

                                                                                              Figure 3: Normalized stress distribution across the channel.

                                                                                              Turbulent Pipe Flow Validation Test

                                                                                              The pipe flow test is based on the turbulent pipe flow experiment with by Laufer (1954). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/pipe-flow/.

                                                                                              Figure 4: Normalized velocity distribution across the pipe.

                                                                                              Figure 5: Dimensionless velocity vs dimensionless wall distance.

                                                                                              Figure 6: Normalized turbulent shear stress distribution across the channel.

                                                                                              Backward-Facing Step Flow Validation Test

                                                                                              The backward-facing step (BFS) flow test is based on the BFS flow experiment with by Driver and Seegmiller (1985). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/pipe-flow/. The SA model implementation in Moltres performs largely similarly to the reference SA model results provided on the Turbulence Modeling Resource website.

                                                                                              Table 1: Flow reattachment length estimates (normalized by step height )

                                                                                              Reference experimental dataReference SA modelMoltres

                                                                                              Figure 7: Normalized velocity distribution at equal -4 (upstream of step).

                                                                                              Figure 8: Normalized velocity distribution at various locations (downstream of step).

                                                                                              Figure 9: Skin friction coefficient along the bottom wall.

                                                                                              Figure 10: Skin pressure coefficient along the bottom wall.

                                                                                              Figure 11: Normalized turbulent shear stress distribution at various locations (downstream of step).

                                                                                              Figure 12: Close-up of the velocity magnitude and streamlines around the backward-facing step

                                                                                              References

                                                                                              1. David M. Driver and H. Lee Seegmiller. +Theory and Methodology | Moltres

                                                                                                Theory and Methodology

                                                                                                The two-step procedure is a common approach for multiphysics full-core nuclear reactor analysis. These steps are:

                                                                                                Step 1: Generate neutron group constant data with a lattice or full-core reactor model on a high-fidelity, continuous/fine-energy neutronics software at various reactor states.

                                                                                                Step 2: Use an intermediate-fidelity, computationally cheaper neutronics software with the neutron group constant data to perform multiphysics reactor analysis.

                                                                                                Moltres falls under Step 2 of the two-step procedure. Moltres solves the conventional multigroup neutron diffusion and delayed neutron precursor equations. The precursor equations include precursor drift terms to account for precursor movement under molten salt flow. Moltres is built on the MOOSE finite element framework, enabling highly flexible and scalable reactor simulations.

                                                                                                Multigroup Neutron Diffusion

                                                                                                The neutron diffusion equation is an approximation to the Boltzmann transport equation, and is derived by taking the zeroth and first moment with respect to , the direction of neutron travel. A full derivation of the diffusion equation will not be presented here for conciseness. Importantly, when taking the first moment of the transport equation the angular flux is assumed to be linearly anisotropic. The approximations reduce the phase space through the elimination of angular dependence, but the resulting equation also has reduced fidelity when compared to the transport equation, particularly in regions where the neutron flux has strong angular dependence. A non-exhaustive list of regions in which the neutron flux strongly depends on angle is near material interfaces between materials with highly dissimilar neutronic properties, within strong absorbers, and within near-void regions. As a deterministic method, the neutron diffusion method also requires discretization of the continuous energy dependence into energy groups consisting of non-overlapping, finite energy ranges across the entire energy spectrum. This energy discretization creates a system of equations referred to as the multigroup neutron diffusion equations:

                                                                                                The delayed neutron precursor distributions are governed by:

                                                                                                Notably, there are two production terms of neutrons, the prompt fission source and delayed neutron precursor decay source. The first term describes the neutrons immediately born from fission, and the second term describes the neutrons born from the radioactive decay of neutron-emitting radionuclides, commonly called delayed neutron precursors. The multigroup neutron diffusion equations are generally impossible to solve analytically for realistic problems and are therefore typically solved with numerical methods. Moltres utilizes the Finite Element Method (FEM) capabilities provided by the MOOSE framework. In FEM, the spatial domain is discretized into finite mesh elements and the time dependence is modeled through discrete time steps and time integration methods.

                                                                                                Table 1: Terms in multi-group neutron diffusion equation and their associated kernels

                                                                                                Term in Multi-Group Diffusion EquationAssociated KernelDefinition of Term
                                                                                                NtTimeDerivativeTime rate of change of energy group g
                                                                                                GroupDiffusionStreaming term of energy group g
                                                                                                SigmaRRemoval from energy group g
                                                                                                InScatterIn-scattering into energy group g
                                                                                                CoupledFissionKernelPrompt fission neutron source
                                                                                                DelayedNeutronSourceDelayed fission neutron source

                                                                                                Table 2: Terms in delayed neutron precursor equation and their associated kernels

                                                                                                Term in Delayed Precursor EquationAssociated Kernel(s)Definition of Term
                                                                                                ScalarTransportTimeDerivativeTime rate of change of precursor population
                                                                                                PrecursorSourceProduction of precursor from fission
                                                                                                PrecursorDecayLoss of precusors due to radioactive decay
                                                                                                DGCoupledAdvection, DGFunctionConvection, DGConvectionAdvection of the precursors

                                                                                                For the advective term in the delayed neutron precursor equation, , there are three kernels. DGCoupledAdvection is used when the velocity is a variable in the simulation, DGFunctionConvection is used when the velocity is a function, and DGConvection is for when the velocity is constant.

                                                                                                Heat Transfer and Fluid Flow

                                                                                                Moltres compiles with the MOOSE Navier-Stokes and Heat Transfer modules for flow modeling capabilities by default. Moltres couples with these modules natively because they are all built on the MOOSE framework.

                                                                                                Past work with Moltres have modeled incompressible salt flow and temperature advection-diffusion with the INS or INSAD implementations of the Navier-Stokes equations (Peterson et al., 2018). Coupling with the compressible or finite volume implementations within the Navier-Stokes module are likely possible, but have not been demonstrated yet.

                                                                                                For turbulence modeling, Moltres has a Spalart-Allmaras (SA) turbulence model (Spalart and Allmaras, 1992) implementation with streamline-upwind Petrov-Galerkin (SUPG) stabilization. On balance the SA model is a complete (does not require prior knowledge of the actual turbulence behavior) and computationally efficient turbulence model for approximating wall-bounded turbulent flows. The SA model implementation in Moltres is compatible with the INSAD implementation only. Additionally, Moltres contains turbulent diffusion physics kernels for temperature and the delayed neutron precursors.

                                                                                                The SA model in Moltres follows the (SA-noft2-R) implementation as described on the NASA Turbulence Modeling Resource website. The term is togglable using the use_ft2_term input parameter (false by default). Moltres' implementation solves for the modified dynamic viscosity which can be easily obtained using to convert to as follows:

                                                                                                (1)

                                                                                                where

                                                                                                and the constants are:

                                                                                                We performed simple verification and validation tests of the SA model in Moltres using reference problems for channel, pipe, and backward-facing step flow. The Moltres test dataset is available on Zenodo. The following subsections show plots comparing results from Moltres to reference data from literature.

                                                                                                Turbulent Channel Flow Verification Test

                                                                                                The channel flow test is based on the direct numerical simulation (DNS) of turbulent channel flow with by Moser et al. (1999). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/channel-flow/.

                                                                                                Figure 1: Normalized velocity distribution across the channel.

                                                                                                Figure 2: Dimensionless velocity vs dimensionless wall distance.

                                                                                                Figure 3: Normalized stress distribution across the channel.

                                                                                                Turbulent Pipe Flow Validation Test

                                                                                                The pipe flow test is based on the turbulent pipe flow experiment with by Laufer (1954). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/pipe-flow/.

                                                                                                Figure 4: Normalized velocity distribution across the pipe.

                                                                                                Figure 5: Dimensionless velocity vs dimensionless wall distance.

                                                                                                Figure 6: Normalized turbulent shear stress distribution across the channel.

                                                                                                Backward-Facing Step Flow Validation Test

                                                                                                The backward-facing step (BFS) flow test is based on the BFS flow experiment with by Driver and Seegmiller (1985). The Moltres input file for this problem may be found in moltres/problems/2023-basic-turbulence-cases/pipe-flow/. The SA model implementation in Moltres performs largely similarly to the reference SA model results provided on the Turbulence Modeling Resource website.

                                                                                                Table 3: Flow reattachment length estimates (normalized by step height )

                                                                                                Reference experimental dataReference SA modelMoltres

                                                                                                Figure 7: Normalized velocity distribution at equal -4 (upstream of step).

                                                                                                Figure 8: Normalized velocity distribution at various locations (downstream of step).

                                                                                                Figure 9: Skin friction coefficient along the bottom wall.

                                                                                                Figure 10: Skin pressure coefficient along the bottom wall.

                                                                                                Figure 11: Normalized turbulent shear stress distribution at various locations (downstream of step).

                                                                                                Figure 12: Close-up of the velocity magnitude and streamlines around the backward-facing step

                                                                                                References

                                                                                                1. David M. Driver and H. Lee Seegmiller. Features of a reattaching turbulent shear layer in divergent channelflow. AIAA Journal, 23(2):163–171, February 1985. -URL: https://arc.aiaa.org/doi/10.2514/3.8890 (visited on 2022-01-17), doi:10.2514/3.8890.[BibTeX]
                                                                                                2. Robert D. Moser, John Kim, and Nagi N. Mansour. Direct numerical simulation of turbulent channel flow up to ReÏ„=590. Physics of Fluids, 11(4):943–945, April 1999. -URL: https://doi.org/10.1063/1.869966 (visited on 2023-10-30), doi:10.1063/1.869966.[BibTeX]
                                                                                                3. John Peterson, Alexander Lindsay, and Fande Kong. Overview of the Incompressible Navier-Stokes simulation capabilities in the MOOSE Framework. Advances in Engineering Software, 119:68–92, May 2018. -doi:10.1016/j.advengsoft.2018.02.004.[BibTeX]
                                                                                                \ No newline at end of file +
                                                                                              \ No newline at end of file diff --git a/getting_started/transient.html b/getting_started/transient.html index 9076c40d7..b6e6b131d 100644 --- a/getting_started/transient.html +++ b/getting_started/transient.html @@ -1 +1 @@ -Time Dependent Simulation with Thermal Hydraulic Coupling and Precursor Looping | Moltres

                                                                                              Time-Dependent Simulation with Thermal-Hydraulic Coupling and Precursor Looping

                                                                                              Tutorial to come at a later date.

                                                                                                \ No newline at end of file +Time Dependent Simulation with Thermal Hydraulic Coupling and Precursor Looping | Moltres

                                                                                                Time-Dependent Simulation with Thermal-Hydraulic Coupling and Precursor Looping

                                                                                                Tutorial to come at a later date.

                                                                                                  \ No newline at end of file diff --git a/getting_started/tutorials.html b/getting_started/tutorials.html index 8489410ca..a55390eb7 100644 --- a/getting_started/tutorials.html +++ b/getting_started/tutorials.html @@ -1 +1 @@ -Tutorials | Moltres

                                                                                                  Tutorials

                                                                                                  The following sections cover various tutorials for group constant file generation and running various types of reactor simulations with Moltres. The tutorials assume that readers have a basic understanding of reactor analysis, molten salt reactors, and the MOOSE framework.

                                                                                                  1. Group Constant File Generation

                                                                                                  Moltres requires group constants in compatible text- or JSON-based format to run reactor simulations. The Moltres GitHub repository provides Python scripts that can automatically parse output files from OpenMC, Serpent 2 and NEWT (in SCALE) and generate the requisite .txt or .json files. The newer moltres_xs.py script supports group constant file generation with all three listed neutron transport software, while the older extractSerpent2GCs.py script supports Serpent 2 only.

                                                                                                  1a. Group Constant File Generation with moltres_xs.py (Recommended)

                                                                                                  1b. Group Constant File Generation with extractSerpent2GCs.py

                                                                                                  2. Multiphysics Reactor Simulations

                                                                                                  Moltres supports various capabilities for reactor simulations including eigenvalue calculation, neutronics/thermal-hydraulics coupling, precursor drift, and out-of-core precursor decay. Moltres can couple different physics/components through full coupling or iterative tight coupling.

                                                                                                  This tutorial webpage is currently a work in progress. Feel free to post on our GitHub Discussions page if your use case is not covered by the existing tutorials below.

                                                                                                  2a. Introduction to the Moltres Input File Syntax

                                                                                                  2b. Eigenvalue Calculation

                                                                                                  2c. Time-Dependent Simulation with Thermal-Hydraulic Coupling and Precursor Looping

                                                                                                  Tip: Recommended Executioner and Preconditioning Settings

                                                                                                  3. Data Postprocessing and Analysis

                                                                                                  Tutorials to come at a later date.

                                                                                                  \ No newline at end of file +Tutorials | Moltres

                                                                                                  Tutorials

                                                                                                  The following sections cover various tutorials for group constant file generation and running various types of reactor simulations with Moltres. The tutorials assume that readers have a basic understanding of reactor analysis, molten salt reactors, and the MOOSE framework.

                                                                                                  1. Group Constant File Generation

                                                                                                  Moltres requires group constants in compatible text- or JSON-based format to run reactor simulations. The Moltres GitHub repository provides Python scripts that can automatically parse output files from OpenMC, Serpent 2 and NEWT (in SCALE) and generate the requisite .txt or .json files. The newer moltres_xs.py script supports group constant file generation with all three listed neutron transport software, while the older extractSerpent2GCs.py script supports Serpent 2 only.

                                                                                                  1a. Group Constant File Generation with moltres_xs.py (Recommended)

                                                                                                  1b. Group Constant File Generation with extractSerpent2GCs.py

                                                                                                  2. Multiphysics Reactor Simulations

                                                                                                  Moltres supports various capabilities for reactor simulations including eigenvalue calculation, neutronics/thermal-hydraulics coupling, precursor drift, and out-of-core precursor decay. Moltres can couple different physics/components through full coupling or iterative tight coupling.

                                                                                                  This tutorial webpage is currently a work in progress. Feel free to post on our GitHub Discussions page if your use case is not covered by the existing tutorials below.

                                                                                                  2a. Introduction to the Moltres Input File Syntax

                                                                                                  2b. Eigenvalue Calculation

                                                                                                  2c. Time-Dependent Simulation with Thermal-Hydraulic Coupling and Precursor Looping

                                                                                                  Tip: Recommended Executioner and Preconditioning Settings

                                                                                                  3. Data Postprocessing and Analysis

                                                                                                  Tutorials to come at a later date.

                                                                                                  \ No newline at end of file diff --git a/help.html b/help.html index 97f558ba2..d297016bd 100644 --- a/help.html +++ b/help.html @@ -1 +1 @@ -Help | Moltres

                                                                                                  Help

                                                                                                  TODO: Add help information

                                                                                                    \ No newline at end of file +Help | Moltres

                                                                                                    Help

                                                                                                    TODO: Add help information

                                                                                                      \ No newline at end of file diff --git a/index.html b/index.html index 835d02619..4de444612 100644 --- a/index.html +++ b/index.html @@ -1 +1 @@ -HOME | Moltres

                                                                                                      HOME

                                                                                                      Moltres

                                                                                                      An open-source MOOSE application for the simulation of molten salt reactors

                                                                                                      Moltres is a finite element-based multiphysics reactor simulation tool for molten salt reactors (MSRs) and other advanced reactors in various dimensions and geometries. Moltres is built on the MOOSE framework and provides multiphysics capabilities to accurately model delayed neutron precursor drift and the strong temperature feedback effects inherent in MSRs. Users have the flexibility of setting up fully coupled solution schemes in which all variables are solved in a single monolithic system, or tightly coupled solution schemes by arbitrarily segregating systems of equations corresponding to separate physics. As a MOOSE-based application, Moltres can also scale efficiently on high-performance computers.

                                                                                                      \ No newline at end of file +HOME | Moltres

                                                                                                      HOME

                                                                                                      Moltres

                                                                                                      An open-source MOOSE application for the simulation of molten salt reactors

                                                                                                      Moltres is a finite element-based multiphysics reactor simulation tool for molten salt reactors (MSRs) and other advanced reactors in various dimensions and geometries. Moltres is built on the MOOSE framework and provides multiphysics capabilities to accurately model delayed neutron precursor drift and the strong temperature feedback effects inherent in MSRs. Users have the flexibility of setting up fully coupled solution schemes in which all variables are solved in a single monolithic system, or tightly coupled solution schemes by arbitrarily segregating systems of equations corresponding to separate physics. As a MOOSE-based application, Moltres can also scale efficiently on high-performance computers.

                                                                                                      \ No newline at end of file diff --git a/publications.html b/publications.html index 0b3b743b5..b0045a604 100644 --- a/publications.html +++ b/publications.html @@ -1,7 +1,7 @@ -List of Publications | Moltres

                                                                                                      List of Publications

                                                                                                      Here is a non-exhaustive list of publications and theses using Moltres. If you have a publication that uses Moltres, please submit a pull request and add it here! We'd love to see your work.

                                                                                                      Journal Publications

                                                                                                      1. Alexander Lindsay and Kathryn Huff. +List of Publications | Moltres

                                                                                                        List of Publications

                                                                                                        Here is a non-exhaustive list of publications and theses using Moltres. If you have a publication that uses Moltres, please submit a pull request and add it here! We'd love to see your work.

                                                                                                        Journal Publications

                                                                                                        1. Alexander Lindsay and Kathryn Huff. Moltres: finite element based simulation of molten salt reactors. The Journal of Open Source Software, 3(21):1–2, January 2018. -doi:10.21105/joss.00298.[BibTeX]
                                                                                                        2. Alexander Lindsay, Gavin Ridley, Andrei Rykhlevskii, and Kathryn Huff. Introduction to Moltres: An application for simulation of Molten Salt Reactors. Annals of Nuclear Energy, 114:530–540, April 2018. -URL: https://linkinghub.elsevier.com/retrieve/pii/S0306454917304760 (visited on 2018-01-08), doi:10.1016/j.anucene.2017.12.025.[BibTeX]
                                                                                                        3. Sun Myung Park and Madicken Munk. Verification of moltres for multiphysics simulations of fast-spectrum molten salt reactors. Annals of Nuclear Energy, 173:109111, August 2022. -URL: https://linkinghub.elsevier.com/retrieve/pii/S0306454922001463 (visited on 2022-04-26), doi:10.1016/j.anucene.2022.109111.[BibTeX]

                                                                                                        Conference Publications

                                                                                                        1. Sun Myung Park and Kathryn D Huff. +

                                                                                                      Conference Publications

                                                                                                      1. Sun Myung Park and Kathryn D Huff. Multiphysics Benchmark Results from Moltres. In Proceedings of the 2021 ANS Virtual Annual Meeting, Reactor Analysis Methods - I. Virtual Meeting, June 2021. American Nuclear Society. (Submitted before May 2021). -URL: https://www.ans.org/meetings/am2021/session/view-587/.[BibTeX]
                                                                                                      2. Sun Myung Park, Andrei Rykhlevskii, and Kathryn Huff. Safety Analysis of the Molten Salt Fast Reactor Fuel Composition using Moltres. In Proceedings of GLOBAL International Fuel Cycle Conference. Seattle, WA, United States, September 2019. American Nuclear Society. -URL: http://epubs.ans.org/?a=47030 (visited on 2019-11-05), doi:10.31224/osf.io/7ce89.[BibTeX]

                                                                                                      Theses

                                                                                                      1. Sun Myung Park. +

                                                                                                      Theses

                                                                                                      1. Sun Myung Park. Advancement and Verification of Moltres for Molten Salt Reactor Safety Analysis. Master's thesis, University of Illinois at Urbana-Champaign, Urbana, IL, August 2020. -URL: https://www.ideals.illinois.edu/handle/2142/108542.[BibTeX]
                                                                                                      2. Roberto Fairhurst-Agosta. Multi-Physics and Technical Analysis of High-Temperature Gas-Cooled Reactors for Hydrogen Production. -Master's thesis, University of Illinois at Urbana-Champaign, Urbana, IL, December 2020.[BibTeX]
                                                                                                      3. Alvin J. H. Lee. Neutronics and Thermal-Hydraulics Analysis of TransAtomic Power Molten Salt Reactor (TAP MSR) Core Under Load Following Operations. Master's thesis, University of Illinois at Urbana-Champaign, Urbana, IL, December 2020. -URL: https://www.ideals.illinois.edu/bitstream/handle/2142/109415/LEE-THESIS-2020.pdf?sequence=1&isAllowed=y.[BibTeX]
                                                                                                      4. Gwendolyn Jin Yi Chee. Fluoride-Salt-Cooled High Temperature Reactor Design Optimization with Evolutionary Algorithms. Dissertation, University of Illinois at Urbana-Champaign, Urbana, IL, August 2022. -URL: https://github.com/arfc/2022-chee-dissertation.[BibTeX]
                                                                                                      \ No newline at end of file +
                                                                                                      \ No newline at end of file diff --git a/source/actions/NtAction.html b/source/actions/NtAction.html index 34e998ed9..03d7c46b1 100644 --- a/source/actions/NtAction.html +++ b/source/actions/NtAction.html @@ -1 +1 @@ -NtAction | Moltres

                                                                                                      NtAction

                                                                                                      buildconstruction:Undocumented Action Class

                                                                                                      The NtAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • account_delayedFalseWhether to account for delayed neutrons.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to account for delayed neutrons.

                                                                                                      • num_groupsThe total number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total number of energy groups.

                                                                                                      • num_precursor_groupsspecifies the total number of precursors to create

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:specifies the total number of precursors to create

                                                                                                      • sss2_inputFalseWhether the input follows sss2 form scattering matrices.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the input follows sss2 form scattering matrices.

                                                                                                      • temperatureName of temperature variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Name of temperature variable

                                                                                                      • use_exp_formFalseWhether concentrations should be in an exponential/logarithmic format.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an exponential/logarithmic format.

                                                                                                      • var_name_basespecifies the base name of the variables

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:specifies the base name of the variables

                                                                                                      Required Parameters

                                                                                                      • active__all__ If specified only the blocks named will be visited and made active

                                                                                                        Default:__all__

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified only the blocks named will be visited and made active

                                                                                                      • blockThe block id where this variable lives

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The block id where this variable lives

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • create_temperature_varTrueWhether to create the temperature variable.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to create the temperature variable.

                                                                                                      • dg_for_temperatureTrueWhether the temperature variable should use discontinuous basis functions.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the temperature variable should use discontinuous basis functions.

                                                                                                      • eigenFalseWhether to run an eigen- instead of a transient- simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to run an eigen- instead of a transient- simulation.

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                      • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

                                                                                                        Default:LAGRANGE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the family of FE shape functions to use for this variable

                                                                                                      • inactiveIf specified blocks matching these identifiers will be skipped.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified blocks matching these identifiers will be skipped.

                                                                                                      • init_nts_from_fileFalseWhether to restart simulation using nt output from a previous simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to restart simulation using nt output from a previous simulation.

                                                                                                      • init_temperature_from_fileFalseWhether to restart simulation using temperature output from a previous simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to restart simulation using temperature output from a previous simulation.

                                                                                                      • jac_testFalseWhether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                      • nt_ic_functionAn initial condition function for the neutrons.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:An initial condition function for the neutrons.

                                                                                                      • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                        Default:FIRST

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                      • pre_blocksThe blocks the precursors live on.

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The blocks the precursors live on.

                                                                                                      • pre_concsAll the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                      • scaling1Specifies a scaling factor to apply to this variable

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Specifies a scaling factor to apply to this variable

                                                                                                      • temp_scalingThe amount by which to scale the temperature variable.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the temperature variable.

                                                                                                      • vacuum_boundariesThe boundaries on which to apply vacuum boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The boundaries on which to apply vacuum boundaries.

                                                                                                      Optional Parameters

                                                                                                      \ No newline at end of file +NtAction | Moltres

                                                                                                      NtAction

                                                                                                      buildconstruction:Undocumented Action Class

                                                                                                      The NtAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • account_delayedFalseWhether to account for delayed neutrons.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to account for delayed neutrons.

                                                                                                      • num_groupsThe total number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total number of energy groups.

                                                                                                      • num_precursor_groupsspecifies the total number of precursors to create

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:specifies the total number of precursors to create

                                                                                                      • sss2_inputFalseWhether the input follows sss2 form scattering matrices.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the input follows sss2 form scattering matrices.

                                                                                                      • temperatureName of temperature variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Name of temperature variable

                                                                                                      • use_exp_formFalseWhether concentrations should be in an exponential/logarithmic format.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an exponential/logarithmic format.

                                                                                                      • var_name_basespecifies the base name of the variables

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:specifies the base name of the variables

                                                                                                      Required Parameters

                                                                                                      • active__all__ If specified only the blocks named will be visited and made active

                                                                                                        Default:__all__

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified only the blocks named will be visited and made active

                                                                                                      • blockThe block id where this variable lives

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The block id where this variable lives

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • create_temperature_varTrueWhether to create the temperature variable.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to create the temperature variable.

                                                                                                      • dg_for_temperatureTrueWhether the temperature variable should use discontinuous basis functions.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the temperature variable should use discontinuous basis functions.

                                                                                                      • eigenFalseWhether to run an eigen- instead of a transient- simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to run an eigen- instead of a transient- simulation.

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                      • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

                                                                                                        Default:LAGRANGE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the family of FE shape functions to use for this variable

                                                                                                      • inactiveIf specified blocks matching these identifiers will be skipped.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified blocks matching these identifiers will be skipped.

                                                                                                      • init_nts_from_fileFalseWhether to restart simulation using nt output from a previous simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to restart simulation using nt output from a previous simulation.

                                                                                                      • init_temperature_from_fileFalseWhether to restart simulation using temperature output from a previous simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to restart simulation using temperature output from a previous simulation.

                                                                                                      • jac_testFalseWhether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                      • nt_ic_functionAn initial condition function for the neutrons.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:An initial condition function for the neutrons.

                                                                                                      • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                        Default:FIRST

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                      • pre_blocksThe blocks the precursors live on.

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The blocks the precursors live on.

                                                                                                      • pre_concsAll the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                      • scaling1Specifies a scaling factor to apply to this variable

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Specifies a scaling factor to apply to this variable

                                                                                                      • temp_scalingThe amount by which to scale the temperature variable.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the temperature variable.

                                                                                                      • vacuum_boundariesThe boundaries on which to apply vacuum boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The boundaries on which to apply vacuum boundaries.

                                                                                                      Optional Parameters

                                                                                                      \ No newline at end of file diff --git a/source/actions/PrecursorAction.html b/source/actions/PrecursorAction.html index 3de1a3440..fe9b7cff3 100644 --- a/source/actions/PrecursorAction.html +++ b/source/actions/PrecursorAction.html @@ -1 +1 @@ -PrecursorAction | Moltres

                                                                                                      PrecursorAction

                                                                                                      buildconstruction:Undocumented Action Class

                                                                                                      The PrecursorAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • loop_precursorsFalseWhether precursors are circulated in coolant loop.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether precursors are circulated in coolant loop.

                                                                                                      • num_groupsThe total number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total number of energy groups.

                                                                                                      • num_precursor_groupsspecifies the total number of precursors to create

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:specifies the total number of precursors to create

                                                                                                      • outlet_boundariesOutflow boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:Outflow boundaries.

                                                                                                      • temperatureName of temperature variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Name of temperature variable

                                                                                                      • var_name_basespecifies the base name of the variables

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:specifies the base name of the variables

                                                                                                      Required Parameters

                                                                                                      • active__all__ If specified only the blocks named will be visited and made active

                                                                                                        Default:__all__

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified only the blocks named will be visited and made active

                                                                                                      • blockThe block id where this variable lives

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The block id where this variable lives

                                                                                                      • constant_velocity_valuesTrueWhether the velocity components are constant with respect to space

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the velocity components are constant with respect to space

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • create_varsTrueWhether this action should create the variables.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether this action should create the variables.

                                                                                                      • eigenFalsewhether neutronics is in eigenvalue calculation mode

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:whether neutronics is in eigenvalue calculation mode

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                      • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

                                                                                                        Default:LAGRANGE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the family of FE shape functions to use for this variable

                                                                                                      • inactiveIf specified blocks matching these identifiers will be skipped.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified blocks matching these identifiers will be skipped.

                                                                                                      • init_from_fileFalseWhether to initialize the precursors from a file.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to initialize the precursors from a file.

                                                                                                      • inlet_boundariesInflow boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:Inflow boundaries.

                                                                                                      • is_loopappFalseif circulating precursors, whether this is loop app

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:if circulating precursors, whether this is loop app

                                                                                                      • jac_testFalseWhether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                      • kernel_blockOptional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:Optional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

                                                                                                      • multi_appMultiapp name for looping precursors.

                                                                                                        C++ Type:MultiAppName

                                                                                                        Controllable:No

                                                                                                        Description:Multiapp name for looping precursors.

                                                                                                      • nt_exp_formFalseWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • object_suffixAn optional suffix string that can be helpful to avoid object name crashing.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix string that can be helpful to avoid object name crashing.

                                                                                                      • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                        Default:FIRST

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                      • outlet_velName of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

                                                                                                      • scaling1Specifies a scaling factor to apply to this variable

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Specifies a scaling factor to apply to this variable

                                                                                                      • transientTrueWhether to run a transient simulation.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to run a transient simulation.

                                                                                                      • u_defAllows user to specify constant value for u component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • u_funcAllows user to specify function value for u component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for u component of velocity.

                                                                                                      • uvelName of x-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of x-component of velocity

                                                                                                      • v_defAllows user to specify constant value for v component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • v_funcAllows user to specify function value for v component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for v component of velocity.

                                                                                                      • vvelName of y-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of y-component of velocity

                                                                                                      • w_defAllows user to specify constant value for w component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      • w_funcAllows user to specify function value for w component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for w component of velocity.

                                                                                                      • wvelName of z-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of z-component of velocity

                                                                                                      Optional Parameters

                                                                                                      \ No newline at end of file +PrecursorAction | Moltres

                                                                                                      PrecursorAction

                                                                                                      buildconstruction:Undocumented Action Class

                                                                                                      The PrecursorAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • loop_precursorsFalseWhether precursors are circulated in coolant loop.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether precursors are circulated in coolant loop.

                                                                                                      • num_groupsThe total number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total number of energy groups.

                                                                                                      • num_precursor_groupsspecifies the total number of precursors to create

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:specifies the total number of precursors to create

                                                                                                      • outlet_boundariesOutflow boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:Outflow boundaries.

                                                                                                      • temperatureName of temperature variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Name of temperature variable

                                                                                                      • var_name_basespecifies the base name of the variables

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:specifies the base name of the variables

                                                                                                      Required Parameters

                                                                                                      • active__all__ If specified only the blocks named will be visited and made active

                                                                                                        Default:__all__

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified only the blocks named will be visited and made active

                                                                                                      • blockThe block id where this variable lives

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The block id where this variable lives

                                                                                                      • constant_velocity_valuesTrueWhether the velocity components are constant with respect to space

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the velocity components are constant with respect to space

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • create_varsTrueWhether this action should create the variables.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether this action should create the variables.

                                                                                                      • eigenFalsewhether neutronics is in eigenvalue calculation mode

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:whether neutronics is in eigenvalue calculation mode

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                      • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

                                                                                                        Default:LAGRANGE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the family of FE shape functions to use for this variable

                                                                                                      • inactiveIf specified blocks matching these identifiers will be skipped.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:If specified blocks matching these identifiers will be skipped.

                                                                                                      • init_from_fileFalseWhether to initialize the precursors from a file.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to initialize the precursors from a file.

                                                                                                      • inlet_boundariesInflow boundaries.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:Inflow boundaries.

                                                                                                      • is_loopappFalseif circulating precursors, whether this is loop app

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:if circulating precursors, whether this is loop app

                                                                                                      • jac_testFalseWhether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether we're testing the Jacobian and should use some random initial conditions for the precursors.

                                                                                                      • kernel_blockOptional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:Optional list of block names/IDs in which toinitialize kernels if user wishes to omit kernelsfrom the base list of blocks. Replaces the 'block'parameter when initializing kernels.

                                                                                                      • multi_appMultiapp name for looping precursors.

                                                                                                        C++ Type:MultiAppName

                                                                                                        Controllable:No

                                                                                                        Description:Multiapp name for looping precursors.

                                                                                                      • nt_exp_formFalseWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • object_suffixAn optional suffix string that can be helpful to avoid object name crashing.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix string that can be helpful to avoid object name crashing.

                                                                                                      • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                        Default:FIRST

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

                                                                                                        Controllable:No

                                                                                                        Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

                                                                                                      • outlet_velName of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of the velocity variable normal to the outlet for calculating the flow-averaged precursor concentration outflow when using Navier-Stokes flow.

                                                                                                      • scaling1Specifies a scaling factor to apply to this variable

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Specifies a scaling factor to apply to this variable

                                                                                                      • transientTrueWhether to run a transient simulation.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to run a transient simulation.

                                                                                                      • u_defAllows user to specify constant value for u component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • u_funcAllows user to specify function value for u component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for u component of velocity.

                                                                                                      • uvelName of x-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of x-component of velocity

                                                                                                      • v_defAllows user to specify constant value for v component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • v_funcAllows user to specify function value for v component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for v component of velocity.

                                                                                                      • vvelName of y-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of y-component of velocity

                                                                                                      • w_defAllows user to specify constant value for w component of velocity.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      • w_funcAllows user to specify function value for w component of velocity.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify function value for w component of velocity.

                                                                                                      • wvelName of z-component of velocity

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:Name of z-component of velocity

                                                                                                      Optional Parameters

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/ConstantDifferenceAux.html b/source/auxkernels/ConstantDifferenceAux.html index b9543500b..9b17c371c 100644 --- a/source/auxkernels/ConstantDifferenceAux.html +++ b/source/auxkernels/ConstantDifferenceAux.html @@ -1,4 +1,4 @@ -ConstantDifferenceAux | Moltres

                                                                                                      ConstantDifferenceAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ConstantDifferenceAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • compareVarCoupled variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Coupled variable

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • constant0Scalar value subtracted from compareVar

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:Scalar value subtracted from compareVar

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/Density.html b/source/auxkernels/Density.html index 50e8790fa..058c9ed91 100644 --- a/source/auxkernels/Density.html +++ b/source/auxkernels/Density.html @@ -1 +1 @@ -Density | Moltres

                                                                                                      Density

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The Density has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • density_logThe variable representing the log of the density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The variable representing the log of the density.

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +Density | Moltres

                                                                                                      Density

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The Density has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • density_logThe variable representing the log of the density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The variable representing the log of the density.

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/FissionHeatSourceAux.html b/source/auxkernels/FissionHeatSourceAux.html index db6b6b088..c5a6f01ae 100644 --- a/source/auxkernels/FissionHeatSourceAux.html +++ b/source/auxkernels/FissionHeatSourceAux.html @@ -1,321 +1,606 @@ -FissionHeatSourceAux | Moltres

                                                                                                      FissionHeatSourceAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FissionHeatSourceAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • powerThe reactor power.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The reactor power.

                                                                                                      • tot_fission_heatThe total fission heat postprocessor that's used to normalize the heat source.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The total fission heat postprocessor that's used to normalize the heat source.

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/FissionHeatSourceTransientAux.html b/source/auxkernels/FissionHeatSourceTransientAux.html index ec724db62..1335153a8 100644 --- a/source/auxkernels/FissionHeatSourceTransientAux.html +++ b/source/auxkernels/FissionHeatSourceTransientAux.html @@ -1,80 +1,69 @@ -FissionHeatSourceTransientAux | Moltres

                                                                                                      FissionHeatSourceTransientAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FissionHeatSourceTransientAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/FunctionDerivativeAux.html b/source/auxkernels/FunctionDerivativeAux.html index 7e018686d..3026a3fe0 100644 --- a/source/auxkernels/FunctionDerivativeAux.html +++ b/source/auxkernels/FunctionDerivativeAux.html @@ -1 +1 @@ -FunctionDerivativeAux | Moltres

                                                                                                      FunctionDerivativeAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FunctionDerivativeAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • componentWhat component to take the derivative with respect to. Should be either 1, 2, or 3.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:What component to take the derivative with respect to. Should be either 1, 2, or 3.

                                                                                                      • functionThe function to use as the value

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The function to use as the value

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +FunctionDerivativeAux | Moltres

                                                                                                      FunctionDerivativeAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FunctionDerivativeAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • componentWhat component to take the derivative with respect to. Should be either 1, 2, or 3.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:What component to take the derivative with respect to. Should be either 1, 2, or 3.

                                                                                                      • functionThe function to use as the value

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The function to use as the value

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/MatDiffusionAux.html b/source/auxkernels/MatDiffusionAux.html index e35e14ccc..b10c6609f 100644 --- a/source/auxkernels/MatDiffusionAux.html +++ b/source/auxkernels/MatDiffusionAux.html @@ -1,4 +1,4 @@ -MatDiffusionAux | Moltres

                                                                                                      MatDiffusionAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatDiffusionAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • diffuse_varThe variable that's diffusing.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The variable that's diffusing.

                                                                                                      • prop_namethe name of the material property we are going to use

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:the name of the material property we are going to use

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/ModeratorHeatSourceTransientAux.html b/source/auxkernels/ModeratorHeatSourceTransientAux.html index a98ec20e4..1ce17a048 100644 --- a/source/auxkernels/ModeratorHeatSourceTransientAux.html +++ b/source/auxkernels/ModeratorHeatSourceTransientAux.html @@ -1,80 +1,69 @@ -ModeratorHeatSourceTransientAux | Moltres

                                                                                                      ModeratorHeatSourceTransientAux

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ModeratorHeatSourceTransientAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • average_fission_heatThe average fission heat being generated in the fuel portion of the reactor.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The average fission heat being generated in the fuel portion of the reactor.

                                                                                                      • gammaThe ratio of power density generated in the moderator vs. the fuel.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The ratio of power density generated in the moderator vs. the fuel.

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/SATurbulentViscosityAux.html b/source/auxkernels/SATurbulentViscosityAux.html index 6784b3614..a427c13f1 100644 --- a/source/auxkernels/SATurbulentViscosityAux.html +++ b/source/auxkernels/SATurbulentViscosityAux.html @@ -1,4 +1,4 @@ -SATurbulentViscosityAux | Moltres

                                                                                                      SATurbulentViscosityAux

                                                                                                      Computes the turbulent viscosity for the Spalart-Allmaras turbulence model.

                                                                                                      Overview

                                                                                                      This object computes the turbulent viscosity as described here.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeScaled turbulent viscosity variable from the Spalart-Allmaras transport equation.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Scaled turbulent viscosity variable from the Spalart-Allmaras transport equation.

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • mu_namemuThe name of the viscosity material property

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the viscosity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/TurbulentStressAux.html b/source/auxkernels/TurbulentStressAux.html index af418859e..2a911509d 100644 --- a/source/auxkernels/TurbulentStressAux.html +++ b/source/auxkernels/TurbulentStressAux.html @@ -1,4 +1,4 @@ -TurbulentStressAux | Moltres

                                                                                                      TurbulentStressAux

                                                                                                      Computes the turbulent stress introduced by the Spalart-Allmaras model.

                                                                                                      Overview

                                                                                                      This object computes the turbulent stress under the Spalart-Allmaras model.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • mu_namemuThe name of the viscosity material property

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the viscosity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoThe name of the density material property

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density material property

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/WallDistanceAux.html b/source/auxkernels/WallDistanceAux.html index 6cbf95676..fac1cdf44 100644 --- a/source/auxkernels/WallDistanceAux.html +++ b/source/auxkernels/WallDistanceAux.html @@ -1,4 +1,4 @@ -WallDistanceAux | Moltres

                                                                                                      WallDistanceAux

                                                                                                      Computes the minimum wall distance of each node from wall boundaries

                                                                                                      Overview

                                                                                                      This object computes the minimum distance of each mesh node to the nearest wall node. The wall distance calculation may be slightly inaccurate for unstructured or skewed structured meshes as illustrated on the Turbulence Modeling Resource webpage.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      • wallsBoundaries that correspond to solid walls

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:Boundaries that correspond to solid walls

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/WallShearStressAux.html b/source/auxkernels/WallShearStressAux.html index e01376caf..e553fdafa 100644 --- a/source/auxkernels/WallShearStressAux.html +++ b/source/auxkernels/WallShearStressAux.html @@ -1,4 +1,4 @@ -WallShearStressAux | Moltres

                                                                                                      WallShearStressAux

                                                                                                      Computes the wall shear stress along the given boundary.

                                                                                                      Overview

                                                                                                      This object computes the wall shear stress where is the direction of fluid flow and is the direction perpendicular to the wall. Moltres automatically detects and sets the appropriate directions. This object is valid for straight walls and non-separated flows only (i.e. no reversed flow along the wall).

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this object applies to

                                                                                                        C++ Type:AuxVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object applies to

                                                                                                      • velocityThe velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The velocity

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

                                                                                                      • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                        Default:LINEAR TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

                                                                                                      • mu_namemuThe name of the dynamic viscosity

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/ChannelGradientBC.html b/source/bcs/ChannelGradientBC.html index d9058f383..d423ffed5 100644 --- a/source/bcs/ChannelGradientBC.html +++ b/source/bcs/ChannelGradientBC.html @@ -1 +1 @@ -ChannelGradientBC | Moltres

                                                                                                      ChannelGradientBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ChannelGradientBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • axisWhat coordinate axis this boundary lies on

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:x, y, z

                                                                                                        Controllable:No

                                                                                                        Description:What coordinate axis this boundary lies on

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • channel_gradient_ppsThe vector postprocessor name that holds the channel gradient.

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The vector postprocessor name that holds the channel gradient.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • h_namehThe name of the heat transfer coefficient

                                                                                                        Default:h

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the heat transfer coefficient

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +ChannelGradientBC | Moltres

                                                                                                      ChannelGradientBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ChannelGradientBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • axisWhat coordinate axis this boundary lies on

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:x, y, z

                                                                                                        Controllable:No

                                                                                                        Description:What coordinate axis this boundary lies on

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • channel_gradient_ppsThe vector postprocessor name that holds the channel gradient.

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The vector postprocessor name that holds the channel gradient.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • h_namehThe name of the heat transfer coefficient

                                                                                                        Default:h

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the heat transfer coefficient

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/ConservativeAdvectionNoBCBC.html b/source/bcs/ConservativeAdvectionNoBCBC.html index 607ee5caf..ede0a1ec2 100644 --- a/source/bcs/ConservativeAdvectionNoBCBC.html +++ b/source/bcs/ConservativeAdvectionNoBCBC.html @@ -1,4 +1,4 @@ -ConservativeAdvectionNoBCBC | Moltres

                                                                                                      ConservativeAdvectionNoBCBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ConservativeAdvectionNoBCBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/CoupledOutflowBC.html b/source/bcs/CoupledOutflowBC.html index 232c0ac3d..230735cab 100644 --- a/source/bcs/CoupledOutflowBC.html +++ b/source/bcs/CoupledOutflowBC.html @@ -1,4 +1,4 @@ -CoupledOutflowBC | Moltres

                                                                                                      CoupledOutflowBC

                                                                                                      DG outflow for convection on Navier-Stokes velocity variables

                                                                                                      Overview

                                                                                                      This object adds the outflow boundary condition for the delayed neutron precursor equation if CoupledScalarAdvection is used (i.e. integration by parts and divergence theorem). The weak form for this boundary condition is:

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • uvelx direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vvely direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y direction velocity

                                                                                                      • wvelz direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z direction velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/CoupledScalarAdvectionNoBCBC.html b/source/bcs/CoupledScalarAdvectionNoBCBC.html index 1ba2139b6..70099ff2e 100644 --- a/source/bcs/CoupledScalarAdvectionNoBCBC.html +++ b/source/bcs/CoupledScalarAdvectionNoBCBC.html @@ -1,4 +1,4 @@ -CoupledScalarAdvectionNoBCBC | Moltres

                                                                                                      CoupledScalarAdvectionNoBCBC

                                                                                                      Overview

                                                                                                      This object adds the "No Boundary Condition" outflow boundary condition devised by Griffiths.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/DGDiffusionPostprocessorDirichletBC.html b/source/bcs/DGDiffusionPostprocessorDirichletBC.html index 9509ab22e..47df949ba 100644 --- a/source/bcs/DGDiffusionPostprocessorDirichletBC.html +++ b/source/bcs/DGDiffusionPostprocessorDirichletBC.html @@ -1 +1 @@ -DGDiffusionPostprocessorDirichletBC | Moltres

                                                                                                      DGDiffusionPostprocessorDirichletBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGDiffusionPostprocessorDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • epsilonEpsilon

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Epsilon

                                                                                                      • postprocessorThe postprocessor providing the value to set on the boundary (with optional scaling and offset).

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor providing the value to set on the boundary (with optional scaling and offset).

                                                                                                      • sigmaSigma

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Sigma

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • D_nameDThe diffusion (or thermal conductivity or viscosity) coefficient.

                                                                                                        Default:D

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The diffusion (or thermal conductivity or viscosity) coefficient.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • value0The value the variable should have on the boundary

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The value the variable should have on the boundary

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DGDiffusionPostprocessorDirichletBC | Moltres

                                                                                                      DGDiffusionPostprocessorDirichletBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGDiffusionPostprocessorDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • epsilonEpsilon

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Epsilon

                                                                                                      • postprocessorThe postprocessor providing the value to set on the boundary (with optional scaling and offset).

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor providing the value to set on the boundary (with optional scaling and offset).

                                                                                                      • sigmaSigma

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Sigma

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • D_nameDThe diffusion (or thermal conductivity or viscosity) coefficient.

                                                                                                        Default:D

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The diffusion (or thermal conductivity or viscosity) coefficient.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • value0The value the variable should have on the boundary

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The value the variable should have on the boundary

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/DiffusionNoBCBC.html b/source/bcs/DiffusionNoBCBC.html index 5612b2629..f9ed1324b 100644 --- a/source/bcs/DiffusionNoBCBC.html +++ b/source/bcs/DiffusionNoBCBC.html @@ -1,4 +1,4 @@ -DiffusionNoBCBC | Moltres

                                                                                                      DiffusionNoBCBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DiffusionNoBCBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      The Laplacian operator (), with the weak form of .

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/DiffusiveFluxBC.html b/source/bcs/DiffusiveFluxBC.html index 4c398ba30..459455a1f 100644 --- a/source/bcs/DiffusiveFluxBC.html +++ b/source/bcs/DiffusiveFluxBC.html @@ -1 +1 @@ -DiffusiveFluxBC | Moltres

                                                                                                      DiffusiveFluxBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DiffusiveFluxBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • D_nameDThe name of the diffusivity, conductivity, or viscosity.

                                                                                                        Default:D

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the diffusivity, conductivity, or viscosity.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DiffusiveFluxBC | Moltres

                                                                                                      DiffusiveFluxBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DiffusiveFluxBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • D_nameDThe name of the diffusivity, conductivity, or viscosity.

                                                                                                        Default:D

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the diffusivity, conductivity, or viscosity.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/ExampleShapeSideIntegratedBC.html b/source/bcs/ExampleShapeSideIntegratedBC.html index 6ba2063a7..659ee6d03 100644 --- a/source/bcs/ExampleShapeSideIntegratedBC.html +++ b/source/bcs/ExampleShapeSideIntegratedBC.html @@ -1 +1 @@ -ExampleShapeSideIntegratedBC | Moltres

                                                                                                      ExampleShapeSideIntegratedBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ExampleShapeSideIntegratedBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • VbInitial potential applied to the boundary.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Initial potential applied to the boundary.

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • denom_user_objectShapeSideUserObject for computing integral component in denominator.

                                                                                                        C++ Type:UserObjectName

                                                                                                        Controllable:No

                                                                                                        Description:ShapeSideUserObject for computing integral component in denominator.

                                                                                                      • num_user_objectShapeSideUserObject for computing integral component in numerator.

                                                                                                        C++ Type:UserObjectName

                                                                                                        Controllable:No

                                                                                                        Description:ShapeSideUserObject for computing integral component in numerator.

                                                                                                      • vCharge species.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charge species.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +ExampleShapeSideIntegratedBC | Moltres

                                                                                                      ExampleShapeSideIntegratedBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ExampleShapeSideIntegratedBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • VbInitial potential applied to the boundary.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Initial potential applied to the boundary.

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • denom_user_objectShapeSideUserObject for computing integral component in denominator.

                                                                                                        C++ Type:UserObjectName

                                                                                                        Controllable:No

                                                                                                        Description:ShapeSideUserObject for computing integral component in denominator.

                                                                                                      • num_user_objectShapeSideUserObject for computing integral component in numerator.

                                                                                                        C++ Type:UserObjectName

                                                                                                        Controllable:No

                                                                                                        Description:ShapeSideUserObject for computing integral component in numerator.

                                                                                                      • vCharge species.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charge species.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/FlexiblePostprocessorDirichletBC.html b/source/bcs/FlexiblePostprocessorDirichletBC.html index 7a7751cc8..4c72eca58 100644 --- a/source/bcs/FlexiblePostprocessorDirichletBC.html +++ b/source/bcs/FlexiblePostprocessorDirichletBC.html @@ -1 +1 @@ -FlexiblePostprocessorDirichletBC | Moltres

                                                                                                      FlexiblePostprocessorDirichletBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FlexiblePostprocessorDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor to set the value to on the boundary.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor to set the value to on the boundary.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor value by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor value by

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsresidualThe tag for the vectors this Kernel should fill

                                                                                                        Default:residual

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time, residual

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +FlexiblePostprocessorDirichletBC | Moltres

                                                                                                      FlexiblePostprocessorDirichletBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The FlexiblePostprocessorDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor to set the value to on the boundary.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor to set the value to on the boundary.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor value by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor value by

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsresidualThe tag for the vectors this Kernel should fill

                                                                                                        Default:residual

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time, residual

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/INSADMassPSPGBC.html b/source/bcs/INSADMassPSPGBC.html index da23af789..da016a5de 100644 --- a/source/bcs/INSADMassPSPGBC.html +++ b/source/bcs/INSADMassPSPGBC.html @@ -1,4 +1,4 @@ -INSADMassPSPGBC | Moltres

                                                                                                      INSADMassPSPGBC

                                                                                                      This class removes INS PSPG contributions along the boundary.

                                                                                                      Overview

                                                                                                      This object removes residual contributions from PSPG stabilization in the INSAD mass equation along the boundaries.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoThe name of the density

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/INSADMomentumSUPGBC.html b/source/bcs/INSADMomentumSUPGBC.html index 1d0df1d3d..1eb0cc916 100644 --- a/source/bcs/INSADMomentumSUPGBC.html +++ b/source/bcs/INSADMomentumSUPGBC.html @@ -1,4 +1,4 @@ -INSADMomentumSUPGBC | Moltres

                                                                                                      INSADMomentumSUPGBC

                                                                                                      This class removes INS SUPG contributions along the boundary.

                                                                                                      Overview

                                                                                                      This object removes residual contributions from SUPG stabilization in the INSAD momentum equation along the boundaries.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoDensity

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:Density

                                                                                                      • tau_nametauThe name of the stabilization parameter tau.

                                                                                                        Default:tau

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the stabilization parameter tau.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/INSADMomentumTurbulentNoBCBC.html b/source/bcs/INSADMomentumTurbulentNoBCBC.html index 101767971..b3f0eaf74 100644 --- a/source/bcs/INSADMomentumTurbulentNoBCBC.html +++ b/source/bcs/INSADMomentumTurbulentNoBCBC.html @@ -1,4 +1,4 @@ -INSADMomentumTurbulentNoBCBC | Moltres

                                                                                                      INSADMomentumTurbulentNoBCBC

                                                                                                      This class implements the 'No BC' boundary condition with additional contributions from turbulent viscosity.

                                                                                                      Overview

                                                                                                      This object applies the "no BC" boundary condition for the INSAD momentum equations with the Spalart-Allmaras turbulence modeling.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • pressurepressure

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:pressure

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • integrate_p_by_partsTrueAllows simulations to be run with pressure BC if set to false

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Allows simulations to be run with pressure BC if set to false

                                                                                                      • mu_namemuThe name of the dynamic viscosity

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • viscous_formlaplaceThe form of the viscous term. Options are 'traction' or 'laplace'

                                                                                                        Default:laplace

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:traction, laplace

                                                                                                        Controllable:No

                                                                                                        Description:The form of the viscous term. Options are 'traction' or 'laplace'

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/InflowBC.html b/source/bcs/InflowBC.html index 3c24bcd05..96e7243cf 100644 --- a/source/bcs/InflowBC.html +++ b/source/bcs/InflowBC.html @@ -1 +1 @@ -InflowBC | Moltres

                                                                                                      InflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The InflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • inlet_concThe inlet concentration

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The inlet concentration

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +InflowBC | Moltres

                                                                                                      InflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The InflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • inlet_concThe inlet concentration

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The inlet concentration

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/LinLogPenaltyDirichletBC.html b/source/bcs/LinLogPenaltyDirichletBC.html index adc7b7194..2927df3cb 100644 --- a/source/bcs/LinLogPenaltyDirichletBC.html +++ b/source/bcs/LinLogPenaltyDirichletBC.html @@ -1,4 +1,4 @@ -LinLogPenaltyDirichletBC | Moltres

                                                                                                      LinLogPenaltyDirichletBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The LinLogPenaltyDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • penaltyLinLogPenalty scalar

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:LinLogPenalty scalar

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • value0Boundary value of the variable

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Boundary value of the variable

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/MatDiffusionFluxBC.html b/source/bcs/MatDiffusionFluxBC.html index b9a635c51..48ecab529 100644 --- a/source/bcs/MatDiffusionFluxBC.html +++ b/source/bcs/MatDiffusionFluxBC.html @@ -1 +1 @@ -MatDiffusionFluxBC | Moltres

                                                                                                      MatDiffusionFluxBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatDiffusionFluxBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • prop_namethe name of the material property we are going to use

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:the name of the material property we are going to use

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +MatDiffusionFluxBC | Moltres

                                                                                                      MatDiffusionFluxBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatDiffusionFluxBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • prop_namethe name of the material property we are going to use

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:the name of the material property we are going to use

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/MatINSTemperatureNoBCBC.html b/source/bcs/MatINSTemperatureNoBCBC.html index daf491950..1d14a2b4b 100644 --- a/source/bcs/MatINSTemperatureNoBCBC.html +++ b/source/bcs/MatINSTemperatureNoBCBC.html @@ -1 +1 @@ -MatINSTemperatureNoBCBC | Moltres

                                                                                                      MatINSTemperatureNoBCBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatINSTemperatureNoBCBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • kThe name of the thermal conductivity material property

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the thermal conductivity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +MatINSTemperatureNoBCBC | Moltres

                                                                                                      MatINSTemperatureNoBCBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatINSTemperatureNoBCBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • kThe name of the thermal conductivity material property

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the thermal conductivity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/OutflowBC.html b/source/bcs/OutflowBC.html index 5004a05f2..a27c3cd3c 100644 --- a/source/bcs/OutflowBC.html +++ b/source/bcs/OutflowBC.html @@ -1 +1 @@ -OutflowBC | Moltres

                                                                                                      OutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The OutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +OutflowBC | Moltres

                                                                                                      OutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The OutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/PostprocessorCoupledInflowBC.html b/source/bcs/PostprocessorCoupledInflowBC.html index e53515bc1..dea21b5ad 100644 --- a/source/bcs/PostprocessorCoupledInflowBC.html +++ b/source/bcs/PostprocessorCoupledInflowBC.html @@ -1,4 +1,4 @@ -PostprocessorCoupledInflowBC | Moltres

                                                                                                      PostprocessorCoupledInflowBC

                                                                                                      Postprocessor inflow for convection on Navier-Stokes velocity variables

                                                                                                      Overview

                                                                                                      This object adds the inflow boundary condition for the delayed neutron precursor equation if CoupledScalarAdvection is used (i.e. integration by parts and divergence theorem). The weak form for this boundary condition is:

                                                                                                      where is the precursor concentration at the inlet and defined by the postprocessor input parameter.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor from which to derive the inlet concentration.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor from which to derive the inlet concentration.

                                                                                                      • uvelx direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vvely direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y direction velocity

                                                                                                      • wvelz direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z direction velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/PostprocessorInflowBC.html b/source/bcs/PostprocessorInflowBC.html index abe19a791..6c864f54f 100644 --- a/source/bcs/PostprocessorInflowBC.html +++ b/source/bcs/PostprocessorInflowBC.html @@ -1 +1 @@ -PostprocessorInflowBC | Moltres

                                                                                                      PostprocessorInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PostprocessorInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor from which to derive the inlet concentration.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor from which to derive the inlet concentration.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +PostprocessorInflowBC | Moltres

                                                                                                      PostprocessorInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PostprocessorInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor from which to derive the inlet concentration.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor from which to derive the inlet concentration.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/PostprocessorTemperatureInflowBC.html b/source/bcs/PostprocessorTemperatureInflowBC.html index 5b9de6e5b..ed8fee97c 100644 --- a/source/bcs/PostprocessorTemperatureInflowBC.html +++ b/source/bcs/PostprocessorTemperatureInflowBC.html @@ -1 +1 @@ -PostprocessorTemperatureInflowBC | Moltres

                                                                                                      PostprocessorTemperatureInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PostprocessorTemperatureInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor from which to derive the inlet concentration.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor from which to derive the inlet concentration.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +PostprocessorTemperatureInflowBC | Moltres

                                                                                                      PostprocessorTemperatureInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PostprocessorTemperatureInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • postprocessorThe postprocessor from which to derive the inlet concentration.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor from which to derive the inlet concentration.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • offset0The amount to offset the scaled postprocessor by

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to offset the scaled postprocessor by

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1The amount to scale the postprocessor value by

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount to scale the postprocessor value by

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/RobinBC.html b/source/bcs/RobinBC.html index e8a983b2b..f0204bd77 100644 --- a/source/bcs/RobinBC.html +++ b/source/bcs/RobinBC.html @@ -1 +1 @@ -RobinBC | Moltres

                                                                                                      RobinBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The RobinBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • velocity1The 1D velocity.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The 1D velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +RobinBC | Moltres

                                                                                                      RobinBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The RobinBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • velocity1The 1D velocity.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The 1D velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/SATurbulentViscosityNoBCBC.html b/source/bcs/SATurbulentViscosityNoBCBC.html index d1ef4ad51..79aea2fd2 100644 --- a/source/bcs/SATurbulentViscosityNoBCBC.html +++ b/source/bcs/SATurbulentViscosityNoBCBC.html @@ -1,4 +1,4 @@ -SATurbulentViscosityNoBCBC | Moltres

                                                                                                      SATurbulentViscosityNoBCBC

                                                                                                      This class implements the 'No BC' boundary condition for the Spalart-Allmaras equation

                                                                                                      Overview

                                                                                                      This object applies the "no BC" boundary condition for the Spalart-Allmaras turbulence model equation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • mu_namemuThe name of the dynamic viscosity

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/SATurbulentViscositySUPGBC.html b/source/bcs/SATurbulentViscositySUPGBC.html index 5cc0aba27..a4610db6f 100644 --- a/source/bcs/SATurbulentViscositySUPGBC.html +++ b/source/bcs/SATurbulentViscositySUPGBC.html @@ -1,4 +1,4 @@ -INSADMomentumSUPGBC | Moltres

                                                                                                      INSADMomentumSUPGBC

                                                                                                      This class removes INS SUPG contributions along the boundary.

                                                                                                      Overview

                                                                                                      This object removes residual contributions from SUPG stabilization in the Spalart-Allmaras turbulence model equation along the boundaries.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoDensity

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:Density

                                                                                                      • tau_nametauThe name of the stabilization parameter tau.

                                                                                                        Default:tau

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the stabilization parameter tau.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/ScalarAdvectionArtDiffNoBCBC.html b/source/bcs/ScalarAdvectionArtDiffNoBCBC.html index bc81faebd..e29df4784 100644 --- a/source/bcs/ScalarAdvectionArtDiffNoBCBC.html +++ b/source/bcs/ScalarAdvectionArtDiffNoBCBC.html @@ -1,8 +1,8 @@ -ScalarAdvectionArtDiffNoBCBC | Moltres

                                                                                                      ScalarAdvectionArtDiffNoBCBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ScalarAdvectionArtDiffNoBCBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1Amount to scale artificial diffusion.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Amount to scale artificial diffusion.

                                                                                                      • tau1The amount by which to scale the artificial diffusion.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the artificial diffusion.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/TemperatureInflowBC.html b/source/bcs/TemperatureInflowBC.html index 53855d4d4..af5e7acbf 100644 --- a/source/bcs/TemperatureInflowBC.html +++ b/source/bcs/TemperatureInflowBC.html @@ -1 +1 @@ -TemperatureInflowBC | Moltres

                                                                                                      TemperatureInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The TemperatureInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • inlet_concThe inlet concentration

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The inlet concentration

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +TemperatureInflowBC | Moltres

                                                                                                      TemperatureInflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The TemperatureInflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • inlet_concThe inlet concentration

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The inlet concentration

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • uu0The x-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The x-component of the velocity

                                                                                                      • vv0The y-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The y-component of the velocity

                                                                                                      • ww0The z-component of the velocity

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The z-component of the velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/TemperatureOutflowBC.html b/source/bcs/TemperatureOutflowBC.html index a0ce9fe3a..55a76a0f1 100644 --- a/source/bcs/TemperatureOutflowBC.html +++ b/source/bcs/TemperatureOutflowBC.html @@ -1 +1 @@ -TemperatureOutflowBC | Moltres

                                                                                                      TemperatureOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The TemperatureOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +TemperatureOutflowBC | Moltres

                                                                                                      TemperatureOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The TemperatureOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/VacuumConcBC.html b/source/bcs/VacuumConcBC.html index f5c27f45c..ffc0d63a8 100644 --- a/source/bcs/VacuumConcBC.html +++ b/source/bcs/VacuumConcBC.html @@ -1,128 +1,137 @@ -VacuumConcBC | Moltres

                                                                                                      VacuumConcBC

                                                                                                      Overview

                                                                                                      This object adds the vacuum boundary condition of the multigroup neutron diffusion equations. The weak form after applying integration by parts to the neutron diffusion term (GroupDiffusion) is:

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/bcs/VelocityFunctionOutflowBC.html b/source/bcs/VelocityFunctionOutflowBC.html index 5b8622190..e4d40e93c 100644 --- a/source/bcs/VelocityFunctionOutflowBC.html +++ b/source/bcs/VelocityFunctionOutflowBC.html @@ -1 +1 @@ -VelocityFunctionOutflowBC | Moltres

                                                                                                      VelocityFunctionOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +VelocityFunctionOutflowBC | Moltres

                                                                                                      VelocityFunctionOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/bcs/VelocityFunctionTemperatureOutflowBC.html b/source/bcs/VelocityFunctionTemperatureOutflowBC.html index cabe2d6e1..7b1eea426 100644 --- a/source/bcs/VelocityFunctionTemperatureOutflowBC.html +++ b/source/bcs/VelocityFunctionTemperatureOutflowBC.html @@ -1 +1 @@ -VelocityFunctionTemperatureOutflowBC | Moltres

                                                                                                      VelocityFunctionTemperatureOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionTemperatureOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +VelocityFunctionTemperatureOutflowBC | Moltres

                                                                                                      VelocityFunctionTemperatureOutflowBC

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionTemperatureOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/dgkernels/DGCoupledAdvection.html b/source/dgkernels/DGCoupledAdvection.html index 4893d994a..52ad4c160 100644 --- a/source/dgkernels/DGCoupledAdvection.html +++ b/source/dgkernels/DGCoupledAdvection.html @@ -1 +1 @@ -DGCoupledAdvection | Moltres

                                                                                                      DGCoupledAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGCoupledAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for convection on Navier-Stokes velocity variables

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • uvelx direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vvely direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y direction velocity

                                                                                                      • wvelz direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z direction velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DGCoupledAdvection | Moltres

                                                                                                      DGCoupledAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGCoupledAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for convection on Navier-Stokes velocity variables

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • uvelx direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vvely direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y direction velocity

                                                                                                      • wvelz direction velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z direction velocity

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/dgkernels/DGFunctionConvection.html b/source/dgkernels/DGFunctionConvection.html index 77791c8b7..15b7c4b30 100644 --- a/source/dgkernels/DGFunctionConvection.html +++ b/source/dgkernels/DGFunctionConvection.html @@ -1 +1 @@ -DGFunctionConvection | Moltres

                                                                                                      DGFunctionConvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGFunctionConvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DGFunctionConvection | Moltres

                                                                                                      DGFunctionConvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGFunctionConvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/dgkernels/DGFunctionTemperatureAdvection.html b/source/dgkernels/DGFunctionTemperatureAdvection.html index 444faa5cb..2a12966e4 100644 --- a/source/dgkernels/DGFunctionTemperatureAdvection.html +++ b/source/dgkernels/DGFunctionTemperatureAdvection.html @@ -1 +1 @@ -DGFunctionTemperatureAdvection | Moltres

                                                                                                      DGFunctionTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGFunctionTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for func temp convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DGFunctionTemperatureAdvection | Moltres

                                                                                                      DGFunctionTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGFunctionTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for func temp convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/dgkernels/DGTemperatureAdvection.html b/source/dgkernels/DGTemperatureAdvection.html index 71ae381eb..6877d7a9d 100644 --- a/source/dgkernels/DGTemperatureAdvection.html +++ b/source/dgkernels/DGTemperatureAdvection.html @@ -1 +1 @@ -DGTemperatureAdvection | Moltres

                                                                                                      DGTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DGTemperatureAdvection | Moltres

                                                                                                      DGTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DGTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/dgkernels/DGTurbulentDiffusion.html b/source/dgkernels/DGTurbulentDiffusion.html index 0446b7425..1afa78acc 100644 --- a/source/dgkernels/DGTurbulentDiffusion.html +++ b/source/dgkernels/DGTurbulentDiffusion.html @@ -1,4 +1,4 @@ -DGTurbulentDiffusion | Moltres

                                                                                                      DGTurbulentDiffusion

                                                                                                      Adds the turbulent diffusion term for delayed neutron precursors using the discontinuous Galerkin method.

                                                                                                      Overview

                                                                                                      This object adds the turbulent diffusion term based on turbulence predicted by the Spalart-Allmaras turbulence model. The and values may be adjusted to attain the desired level of artificial diffusion for eliminating undershoots and overshoots in the solution.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • epsilon-1epsilon

                                                                                                        Default:-1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:epsilon

                                                                                                      • exclude_boundaryThe internal side sets to be excluded from this kernel.

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The internal side sets to be excluded from this kernel.

                                                                                                      • mu_namemuThe name of the dynamic viscosity material proerty

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity material proerty

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoThe name of the density material property

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density material property

                                                                                                      • schmidt_number0.85Turbulent Schmidt number

                                                                                                        Default:0.85

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Turbulent Schmidt number

                                                                                                      • sigma6sigma

                                                                                                        Default:6

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:sigma

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/dirackernels/DiracHX.html b/source/dirackernels/DiracHX.html index fb3466780..786fbb47a 100644 --- a/source/dirackernels/DiracHX.html +++ b/source/dirackernels/DiracHX.html @@ -1,225 +1,4 @@ -DiracHX | Moltres

                                                                                                      DiracHX

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DiracHX has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • pointThe x,y,z coordinates of the point

                                                                                                        C++ Type:libMesh::Point

                                                                                                        Controllable:No

                                                                                                        Description:The x,y,z coordinates of the point

                                                                                                      • powerHX Power in Watts

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:HX Power in Watts

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • allow_moving_sourcesFalseIf true, allow Dirac sources to move, even if the mesh does not move, during the simulation.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:If true, allow Dirac sources to move, even if the mesh does not move, during the simulation.

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • point_not_found_behaviorIGNOREBy default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.

                                                                                                        Default:IGNORE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:ERROR, WARNING, IGNORE

                                                                                                        Controllable:No

                                                                                                        Description:By default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/interface_kernels/InterTemperatureAdvection.html b/source/interface_kernels/InterTemperatureAdvection.html index 744d614f4..b64ee71d0 100644 --- a/source/interface_kernels/InterTemperatureAdvection.html +++ b/source/interface_kernels/InterTemperatureAdvection.html @@ -1 +1 @@ -InterTemperatureAdvection | Moltres

                                                                                                      InterTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The InterTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • neighbor_varThe variable on the other side of the interface.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The variable on the other side of the interface.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • heat_sourceShould have units of power/length^2

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:Should have units of power/length^2

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • u_val0x velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x velocity cm/s

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • v_val0y velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y velocity cm/s

                                                                                                      • w_val0z velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z velocity cm/s

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • diag_save_in_var_sideThis parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the primary ('p') or secondary side ('s').

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:m, s

                                                                                                        Controllable:No

                                                                                                        Description:This parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the primary ('p') or secondary side ('s').

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • save_in_var_sideThis parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the primary ('p') or secondary side ('s').

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:m, s

                                                                                                        Controllable:No

                                                                                                        Description:This parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the primary ('p') or secondary side ('s').

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +InterTemperatureAdvection | Moltres

                                                                                                      InterTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The InterTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      DG upwinding for the convection

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • neighbor_varThe variable on the other side of the interface.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The variable on the other side of the interface.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • heat_sourceShould have units of power/length^2

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:Should have units of power/length^2

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • u_val0x velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x velocity cm/s

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • v_val0y velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y velocity cm/s

                                                                                                      • w_val0z velocity cm/s

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z velocity cm/s

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • diag_save_in_var_sideThis parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the primary ('p') or secondary side ('s').

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:m, s

                                                                                                        Controllable:No

                                                                                                        Description:This parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the primary ('p') or secondary side ('s').

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • save_in_var_sideThis parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the primary ('p') or secondary side ('s').

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:m, s

                                                                                                        Controllable:No

                                                                                                        Description:This parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the primary ('p') or secondary side ('s').

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/ConservativeTemperatureAdvection.html b/source/kernels/ConservativeTemperatureAdvection.html index 7106384aa..111e3e0fe 100644 --- a/source/kernels/ConservativeTemperatureAdvection.html +++ b/source/kernels/ConservativeTemperatureAdvection.html @@ -1 +1 @@ -ConservativeTemperatureAdvection | Moltres

                                                                                                      ConservativeTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ConservativeTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Conservative form of which in its weak form is given by: .

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • upwinding_typenoneType of upwinding used. None: Typically results in overshoots and undershoots, but numerical diffusion is minimized. Full: Overshoots and undershoots are avoided, but numerical diffusion is large

                                                                                                        Default:none

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:none, full

                                                                                                        Controllable:No

                                                                                                        Description:Type of upwinding used. None: Typically results in overshoots and undershoots, but numerical diffusion is minimized. Full: Overshoots and undershoots are avoided, but numerical diffusion is large

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +ConservativeTemperatureAdvection | Moltres

                                                                                                      ConservativeTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ConservativeTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Conservative form of which in its weak form is given by: .

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity vector

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • upwinding_typenoneType of upwinding used. None: Typically results in overshoots and undershoots, but numerical diffusion is minimized. Full: Overshoots and undershoots are avoided, but numerical diffusion is large

                                                                                                        Default:none

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:none, full

                                                                                                        Controllable:No

                                                                                                        Description:Type of upwinding used. None: Typically results in overshoots and undershoots, but numerical diffusion is minimized. Full: Overshoots and undershoots are avoided, but numerical diffusion is large

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/ConvectiveHeatExchanger.html b/source/kernels/ConvectiveHeatExchanger.html index e26e6cf62..b56455acf 100644 --- a/source/kernels/ConvectiveHeatExchanger.html +++ b/source/kernels/ConvectiveHeatExchanger.html @@ -1,4 +1,4 @@ -ConvectiveHeatExchanger | Moltres

                                                                                                      ConvectiveHeatExchanger

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ConvectiveHeatExchanger has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      A uniformly applied heat removal proportional to a differencefrom a nominal temperature. A global heat exchanger.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • htcheat transfer coefficient for q'=h*(T-T_ref)

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:heat transfer coefficient for q'=h*(T-T_ref)

                                                                                                      • trefreference temperature

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:reference temperature

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/CoupledFissionKernel.html b/source/kernels/CoupledFissionKernel.html index 33a97beac..5b125517c 100644 --- a/source/kernels/CoupledFissionKernel.html +++ b/source/kernels/CoupledFissionKernel.html @@ -1,128 +1,137 @@ -CoupledFissionKernel | Moltres

                                                                                                      CoupledFissionKernel

                                                                                                      Overview

                                                                                                      This object adds the neutron source term of the multigroup neutron diffusion equations. If account_delayed=false (i.e. no delayed neutron precursor modeling), the form is used instead.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • account_delayedFalseWhether to account for delayed neutrons.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to account for delayed neutrons.

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • group_numberThe current energy group

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The current energy group

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • temperatureThe temperature used to interpolate material properties

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily introduced to make super/sub-critical systems exactly critical for the CNRS benchmark.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily introduced to make super/sub-critical systems exactly critical for the CNRS benchmark.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/CoupledScalarAdvection.html b/source/kernels/CoupledScalarAdvection.html index 0fa237887..793289d1f 100644 --- a/source/kernels/CoupledScalarAdvection.html +++ b/source/kernels/CoupledScalarAdvection.html @@ -1,4 +1,4 @@ -CoupledScalarAdvection | Moltres

                                                                                                      CoupledScalarAdvection

                                                                                                      Overview

                                                                                                      This object adds the advection term of the delayed neutron precursor equation. can be either constant velocity values defined using the u_def, v_def, and w_def input parameters or coupled velocity variables using the u, v, and w input parameters. Note that we applied the product rule and integration by parts to obtain the following weak form:

                                                                                                      This form is only valid if the divergence of the velocity is zero, . Boundary conditions at the outlet must be defined using OutflowBC, CoupledOutflowBC, or CoupledScalarAdvectionNoBCBC.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/CtrlConservativeAdvection.html b/source/kernels/CtrlConservativeAdvection.html index 547931169..4243aed18 100644 --- a/source/kernels/CtrlConservativeAdvection.html +++ b/source/kernels/CtrlConservativeAdvection.html @@ -1 +1 @@ -CtrlConservativeAdvection | Moltres

                                                                                                      CtrlConservativeAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CtrlConservativeAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • u_valx-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x-direction velocity

                                                                                                      • v_valy-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y-direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • w_valz-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z-direction velocity

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +CtrlConservativeAdvection | Moltres

                                                                                                      CtrlConservativeAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CtrlConservativeAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • u_valx-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x-direction velocity

                                                                                                      • v_valy-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y-direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • w_valz-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z-direction velocity

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/CtrlConservativeTemperatureAdvection.html b/source/kernels/CtrlConservativeTemperatureAdvection.html index 42ac97dcd..22c590e7a 100644 --- a/source/kernels/CtrlConservativeTemperatureAdvection.html +++ b/source/kernels/CtrlConservativeTemperatureAdvection.html @@ -1 +1 @@ -CtrlConservativeTemperatureAdvection | Moltres

                                                                                                      CtrlConservativeTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CtrlConservativeTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • u_valx-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x-direction velocity

                                                                                                      • v_valy-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y-direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • w_valz-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z-direction velocity

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +CtrlConservativeTemperatureAdvection | Moltres

                                                                                                      CtrlConservativeTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CtrlConservativeTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • u_valx-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:x-direction velocity

                                                                                                      • v_valy-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:y-direction velocity

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • w_valz-direction velocity

                                                                                                        C++ Type:double

                                                                                                        Controllable:Yes

                                                                                                        Description:z-direction velocity

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/DecayHeatSource.html b/source/kernels/DecayHeatSource.html index 4c261edfe..2aa7e6fcc 100644 --- a/source/kernels/DecayHeatSource.html +++ b/source/kernels/DecayHeatSource.html @@ -1 +1 @@ -DecayHeatSource | Moltres

                                                                                                      DecayHeatSource

                                                                                                      Overview

                                                                                                      This object adds the decay heat source term of the energy balance equation for temperature.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • decay_heat_constantsDecay heat constants

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay heat constants

                                                                                                      • heat_concsAll the variables that hold the decay heat precursor concentrations.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the decay heat precursor concentrations.

                                                                                                      • num_decay_heat_groupsThe number of decay heat groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of decay heat groups.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DecayHeatSource | Moltres

                                                                                                      DecayHeatSource

                                                                                                      Overview

                                                                                                      This object adds the decay heat source term of the energy balance equation for temperature.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • decay_heat_constantsDecay heat constants

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay heat constants

                                                                                                      • heat_concsAll the variables that hold the decay heat precursor concentrations.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the decay heat precursor concentrations.

                                                                                                      • num_decay_heat_groupsThe number of decay heat groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of decay heat groups.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/DelayedNeutronSource.html b/source/kernels/DelayedNeutronSource.html index a47eeae81..b79f791de 100644 --- a/source/kernels/DelayedNeutronSource.html +++ b/source/kernels/DelayedNeutronSource.html @@ -1,860 +1,984 @@ -DelayedNeutronSource | Moltres

                                                                                                      DelayedNeutronSource

                                                                                                      Overview

                                                                                                      This object adds the delayed neutron source term of the multigroup neutron diffusion equations.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_numberneutron energy group number for chi_d

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:neutron energy group number for chi_d

                                                                                                      • num_precursor_groupsThe number of precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of precursor groups.

                                                                                                      • pre_concsAll the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperatureThe temperature used to interpolate material properties

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/DivFreeCoupledScalarAdvection.html b/source/kernels/DivFreeCoupledScalarAdvection.html index 71416128e..096e4bf5b 100644 --- a/source/kernels/DivFreeCoupledScalarAdvection.html +++ b/source/kernels/DivFreeCoupledScalarAdvection.html @@ -1 +1 @@ -DivFreeCoupledScalarAdvection | Moltres

                                                                                                      DivFreeCoupledScalarAdvection

                                                                                                      Overview

                                                                                                      This object adds the advection term of the delayed neutron precursor equation. can be either constant velocity values defined using the u_def, v_def, and w_def input parameters or coupled velocity variables using the u, v, and w input parameters.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DivFreeCoupledScalarAdvection | Moltres

                                                                                                      DivFreeCoupledScalarAdvection

                                                                                                      Overview

                                                                                                      This object adds the advection term of the delayed neutron precursor equation. can be either constant velocity values defined using the u_def, v_def, and w_def input parameters or coupled velocity variables using the u, v, and w input parameters.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/FissionHeatSource.html b/source/kernels/FissionHeatSource.html index 91743dffb..7d2157594 100644 --- a/source/kernels/FissionHeatSource.html +++ b/source/kernels/FissionHeatSource.html @@ -1,4 +1,4 @@ -FissionHeatSource | Moltres

                                                                                                      FissionHeatSource

                                                                                                      Overview

                                                                                                      This object adds the heat source term of the steady-state temperature advection-diffusion equation with coupled neutron fluxes from a -eigenvalue calculation. The power input parameter allows the user to set a fixed thermal power output regardless of the neutron flux normalization factor. Alternatively, one may choose to normalize the neutron flux instead using the normalization and normal_factor parameters for the InversePowerMethod or NonlinearEigen executioners.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • powerThe reactor power.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The reactor power.

                                                                                                      • tot_fission_heatThe total fission heat postprocessor that's used to normalize the heat source.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The total fission heat postprocessor that's used to normalize the heat source.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/GammaHeatSource.html b/source/kernels/GammaHeatSource.html index 5951a3c5d..019a3577d 100644 --- a/source/kernels/GammaHeatSource.html +++ b/source/kernels/GammaHeatSource.html @@ -1,45 +1,131 @@ -GammaHeatSource | Moltres

                                                                                                      GammaHeatSource

                                                                                                      Overview

                                                                                                      This object adds the gamma heat source term of the temperature advection-diffusion equation where is a factor represeting heat deposition by gamma and neutron irradiation in the moderator.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • average_fission_heatThe average fission heat being generated in the fuel portion of the reactor.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The average fission heat being generated in the fuel portion of the reactor.

                                                                                                      • gammaThe ratio of power density generated in the moderator vs. the fuel.

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The ratio of power density generated in the moderator vs. the fuel.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/GroupDiffusion.html b/source/kernels/GroupDiffusion.html index 90c1555a4..3db59e626 100644 --- a/source/kernels/GroupDiffusion.html +++ b/source/kernels/GroupDiffusion.html @@ -1,4 +1,4 @@ -GroupDiffusion | Moltres

                                                                                                      GroupDiffusion

                                                                                                      Overview

                                                                                                      This object adds the diffusion term of the multigroup neutron diffusion equations. Note that we have applied integration by parts to obtain the following weak form:

                                                                                                      Input Parameters

                                                                                                      • group_numberThe group for which this kernel controls diffusion

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The group for which this kernel controls diffusion

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperatureThe temperature used to interpolate the diffusion coefficient

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate the diffusion coefficient

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/HeatPrecursorDecay.html b/source/kernels/HeatPrecursorDecay.html index b25be7d68..0f2c27a3a 100644 --- a/source/kernels/HeatPrecursorDecay.html +++ b/source/kernels/HeatPrecursorDecay.html @@ -1,4 +1,4 @@ -HeatPrecursorDecay | Moltres

                                                                                                      HeatPrecursorDecay

                                                                                                      Overview

                                                                                                      This object adds the decay term of the decay heat equation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • decay_heat_constantsDecay Heat Constants

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay Heat Constants

                                                                                                      • decay_heat_group_numberThe decay heat group this kernel acts on.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The decay heat group this kernel acts on.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/HeatPrecursorSource.html b/source/kernels/HeatPrecursorSource.html index f55dff069..f57db06fb 100644 --- a/source/kernels/HeatPrecursorSource.html +++ b/source/kernels/HeatPrecursorSource.html @@ -1,4 +1,4 @@ -HeatPrecursorSource | Moltres

                                                                                                      HeatPrecursorSource

                                                                                                      Overview

                                                                                                      This object adds the source term of the decay heat equation where is the fraction of total power attributable to decay heat group .

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • decay_heat_constantsDecay Heat Constants

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay Heat Constants

                                                                                                      • decay_heat_fractionsDecay Heat Fractions

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay Heat Fractions

                                                                                                      • decay_heat_group_numberThe decay heat group this kernel acts on.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The decay heat group this kernel acts on.

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total number of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total number of energy groups

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperature800.0The temperature used to interpolate material properties.

                                                                                                        Default:800.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/INSADEnergyTurbulentDiffusion.html b/source/kernels/INSADEnergyTurbulentDiffusion.html index 5318a2d69..ee0b1b95f 100644 --- a/source/kernels/INSADEnergyTurbulentDiffusion.html +++ b/source/kernels/INSADEnergyTurbulentDiffusion.html @@ -1,4 +1,4 @@ -INSADEnergyTurbulentDiffusion | Moltres

                                                                                                      INSADEnergyTurbulentDiffusion

                                                                                                      Adds the turbulent diffusion term in the INSAD heat equation

                                                                                                      Overview

                                                                                                      This object adds the turbulent diffusion term, based on turbulence predicted by the Spalart-Allmaras turbulence model, of the temperature advection-diffusion equation under the INSAD implementation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • cp_namecpThe name of the specific heat capacity

                                                                                                        Default:cp

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the specific heat capacity

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • mu_namemuThe name of the dynamic viscosity material property

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity material property

                                                                                                      • prandtl_number0.85Prandtl number

                                                                                                        Default:0.85

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Prandtl number

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/INSADMomentumTurbulentViscous.html b/source/kernels/INSADMomentumTurbulentViscous.html index 6f3ed6e16..251a042d9 100644 --- a/source/kernels/INSADMomentumTurbulentViscous.html +++ b/source/kernels/INSADMomentumTurbulentViscous.html @@ -1,4 +1,4 @@ -INSADMomentumTurbulentViscous | Moltres

                                                                                                      INSADMomentumTurbulentViscous

                                                                                                      Adds the turbulent viscous term to the INS momentum equation

                                                                                                      Overview

                                                                                                      This object adds the turbulent viscous term of the incompressible Navier-Stokes momentum equation under the INSAD implementation. The term is integrated by parts. Only the traction form is compatible with the Spalart-Allmaras turbulence model because is generally not constant in space.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • mu_namemuThe name of the viscosity material property

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the viscosity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • viscous_formlaplaceThe form of the viscous term. Options are 'traction' or 'laplace'

                                                                                                        Default:laplace

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:traction, laplace

                                                                                                        Controllable:No

                                                                                                        Description:The form of the viscous term. Options are 'traction' or 'laplace'

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/INSBoussinesqBodyForce.html b/source/kernels/INSBoussinesqBodyForce.html index 7a2061043..69d764af2 100644 --- a/source/kernels/INSBoussinesqBodyForce.html +++ b/source/kernels/INSBoussinesqBodyForce.html @@ -1,4 +1,4 @@ -INSBoussinesqBodyForce | Moltres

                                                                                                      INSBoussinesqBodyForce

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The INSBoussinesqBodyForce has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Computes a body force for natural convection buoyancy.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • component0,1,2 depending on if we are solving the x,y,z component of the momentum equation

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:0,1,2 depending on if we are solving the x,y,z component of the momentum equation

                                                                                                      • gravityDirection of the gravity vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Direction of the gravity vector

                                                                                                      • temperaturetemperature variable, for off diagonal jacobian

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:temperature variable, for off diagonal jacobian

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • alpha_namealphaThe name of the thermal expansion coefficientthis is of the form rho = rho*(1-alpha (T-T_ref))

                                                                                                        Default:alpha

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the thermal expansion coefficientthis is of the form rho = rho*(1-alpha (T-T_ref))

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • ref_temptemp_refThe name of the reference temperature

                                                                                                        Default:temp_ref

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the reference temperature

                                                                                                      • rho_namerhoThe name of the density

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/InScatter.html b/source/kernels/InScatter.html index 9511ec9aa..e204217a0 100644 --- a/source/kernels/InScatter.html +++ b/source/kernels/InScatter.html @@ -1,4 +1,4 @@ -InScatter | Moltres

                                                                                                      InScatter

                                                                                                      Overview

                                                                                                      This object adds the in-scatter term of the multigroup neutron diffusion equations.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • group_numberThe current energy group

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The current energy group

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperatureThe temperature used to interpolate material properties

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/MatINSTemperatureTimeDerivative.html b/source/kernels/MatINSTemperatureTimeDerivative.html index 3bebae7f4..4c31284c4 100644 --- a/source/kernels/MatINSTemperatureTimeDerivative.html +++ b/source/kernels/MatINSTemperatureTimeDerivative.html @@ -1 +1 @@ -MatINSTemperatureTimeDerivative | Moltres

                                                                                                      MatINSTemperatureTimeDerivative

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatINSTemperatureTimeDerivative has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      The time derivative operator with the weak form of .

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • lumpingFalseTrue for mass matrix lumping, false otherwise

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:True for mass matrix lumping, false otherwise

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagstimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +MatINSTemperatureTimeDerivative | Moltres

                                                                                                      MatINSTemperatureTimeDerivative

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MatINSTemperatureTimeDerivative has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      The time derivative operator with the weak form of .

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • lumpingFalseTrue for mass matrix lumping, false otherwise

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:True for mass matrix lumping, false otherwise

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagstimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/NonConservativeAdvection.html b/source/kernels/NonConservativeAdvection.html index a6a9869a4..7ab45c1cb 100644 --- a/source/kernels/NonConservativeAdvection.html +++ b/source/kernels/NonConservativeAdvection.html @@ -1 +1 @@ -NonConservativeAdvection | Moltres

                                                                                                      NonConservativeAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The NonConservativeAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity Vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity Vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +NonConservativeAdvection | Moltres

                                                                                                      NonConservativeAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The NonConservativeAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • velocityVelocity Vector

                                                                                                        C++ Type:libMesh::VectorValue<double>

                                                                                                        Controllable:No

                                                                                                        Description:Velocity Vector

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/NtTimeDerivative.html b/source/kernels/NtTimeDerivative.html index cec054d71..38e22b1a4 100644 --- a/source/kernels/NtTimeDerivative.html +++ b/source/kernels/NtTimeDerivative.html @@ -1,26 +1,21 @@ -NtTimeDerivative | Moltres

                                                                                                      NtTimeDerivative

                                                                                                      Overview

                                                                                                      This object adds the time derivative term of the multigroup neutron diffusion equations.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_numberThe group for which this kernel controls diffusion

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The group for which this kernel controls diffusion

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • lumpingFalseTrue for mass matrix lumping, false otherwise

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:True for mass matrix lumping, false otherwise

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperatureThe temperature used to interpolate the diffusion coefficient

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate the diffusion coefficient

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagstimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/PotentialAdvection.html b/source/kernels/PotentialAdvection.html index 59dd593ec..6d5d9ec81 100644 --- a/source/kernels/PotentialAdvection.html +++ b/source/kernels/PotentialAdvection.html @@ -1 +1 @@ -PotentialAdvection | Moltres

                                                                                                      PotentialAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PotentialAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • positive_chargeTrueWhether the potential is advecting positive charges. Should be set to false if charges are negative.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the potential is advecting positive charges. Should be set to false if charges are negative.

                                                                                                      • potentialThe potential responsible for charge advection

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The potential responsible for charge advection

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +PotentialAdvection | Moltres

                                                                                                      PotentialAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The PotentialAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • positive_chargeTrueWhether the potential is advecting positive charges. Should be set to false if charges are negative.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether the potential is advecting positive charges. Should be set to false if charges are negative.

                                                                                                      • potentialThe potential responsible for charge advection

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The potential responsible for charge advection

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/kernels/PrecursorDecay.html b/source/kernels/PrecursorDecay.html index cf2ce07d5..64dee1483 100644 --- a/source/kernels/PrecursorDecay.html +++ b/source/kernels/PrecursorDecay.html @@ -1,4 +1,4 @@ -PrecursorDecay | Moltres

                                                                                                      PrecursorDecay

                                                                                                      Overview

                                                                                                      This object adds the decay term of the delayed neutron precursor equation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • precursor_group_numberWhat precursor group this kernel is acting on.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:What precursor group this kernel is acting on.

                                                                                                      • temperatureThe temperature used to interpolate material properties.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prec_scale1The amount by which to scale precursors.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale precursors.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/PrecursorSource.html b/source/kernels/PrecursorSource.html index 6c3971ef6..37e83c39a 100644 --- a/source/kernels/PrecursorSource.html +++ b/source/kernels/PrecursorSource.html @@ -1,4 +1,4 @@ -PrecursorSource | Moltres

                                                                                                      PrecursorSource

                                                                                                      Overview

                                                                                                      This object adds the source term of the delayed neutron precursor equation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • eigenvalue_scaling1Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Artificial scaling factor for the fission source. Primarily for introducing artificial reactivity to make super/subcritical systems exactly critical or to simulate reactivity insertions/withdrawals.

                                                                                                      • prec_scale1The factor by which the neutron fluxes are scaled.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The factor by which the neutron fluxes are scaled.

                                                                                                      • precursor_group_numberWhat precursor group this kernel is acting on.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:What precursor group this kernel is acting on.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperature800.0The temperature used to interpolate material properties.

                                                                                                        Default:800.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/SATimeDerivative.html b/source/kernels/SATimeDerivative.html index ca0377f15..4d398bcd4 100644 --- a/source/kernels/SATimeDerivative.html +++ b/source/kernels/SATimeDerivative.html @@ -1,4 +1,4 @@ -SATimeDerivative | Moltres

                                                                                                      SATimeDerivative

                                                                                                      Adds the time derivative term of the Spalart-Allmaras turbulence model.

                                                                                                      Overview

                                                                                                      This object adds the time derivative term of the Spalart-Allmaras turbulence model.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagstimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/SATurbulentViscosity.html b/source/kernels/SATurbulentViscosity.html index 96d162832..e334ae4fe 100644 --- a/source/kernels/SATurbulentViscosity.html +++ b/source/kernels/SATurbulentViscosity.html @@ -1,4 +1,4 @@ -SATurbulentViscosity | Moltres

                                                                                                      SATurbulentViscosity

                                                                                                      Adds all terms in the turbulent viscosity equation from the Spalart-Allmaras model

                                                                                                      Overview

                                                                                                      This object adds the Spalart-Allmaras turbulent viscosity equation as described here.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • mu_namemuThe name of the dynamic viscosity material property

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity material property

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/ScalarAdvectionArtDiff.html b/source/kernels/ScalarAdvectionArtDiff.html index 2cd8bffe6..94e88f564 100644 --- a/source/kernels/ScalarAdvectionArtDiff.html +++ b/source/kernels/ScalarAdvectionArtDiff.html @@ -1,8 +1,117 @@ -ScalarAdvectionArtDiff | Moltres

                                                                                                      ScalarAdvectionArtDiff

                                                                                                      This class computes the residual and Jacobian contributions from the artificial diffusion term, .

                                                                                                      Overview

                                                                                                      This object adds an isotropic artificial diffusion term where:

                                                                                                      and

                                                                                                      This scheme is not recommended for most simulations because it tends to produce overly diffusive results.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • diffusivityDThe diffusivity value or material property

                                                                                                        Default:D

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The diffusivity value or material property

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • scale1Amount to scale artificial diffusion.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Amount to scale artificial diffusion.

                                                                                                      • ux-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:x-velocity

                                                                                                      • u_def0Allows user to specify constant value for u component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for u component of velocity.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • vy-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:y-velocity

                                                                                                      • v_def0Allows user to specify constant value for v component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for v component of velocity.

                                                                                                      • wz-velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:z-velocity

                                                                                                      • w_def0Allows user to specify constant value for w component of velocity.

                                                                                                        Default:0

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Allows user to specify constant value for w component of velocity.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/ScalarTransportTimeDerivative.html b/source/kernels/ScalarTransportTimeDerivative.html index e56fea3d3..01337efa9 100644 --- a/source/kernels/ScalarTransportTimeDerivative.html +++ b/source/kernels/ScalarTransportTimeDerivative.html @@ -1,4 +1,4 @@ -ScalarTransportTimeDerivative | Moltres

                                                                                                      ScalarTransportTimeDerivative

                                                                                                      Overview

                                                                                                      This object adds the time derivative term of the delayed neutron precursor or decay heat equations.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • conc_scaling1The amount by which to scale the concentration variable.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The amount by which to scale the concentration variable.

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • lumpingFalseTrue for mass matrix lumping, false otherwise

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:True for mass matrix lumping, false otherwise

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

                                                                                                        Default:system time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagstimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:time

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      Child Objects

                                                                                                      \ No newline at end of file diff --git a/source/kernels/SigmaR.html b/source/kernels/SigmaR.html index 2a82bccdc..ad566f5d3 100644 --- a/source/kernels/SigmaR.html +++ b/source/kernels/SigmaR.html @@ -1,4 +1,4 @@ -SigmaR | Moltres

                                                                                                      SigmaR

                                                                                                      Overview

                                                                                                      This object adds the removal term of the multigroup neutron diffusion equations.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_numberThe current energy group.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The current energy group.

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperatureThe temperature used to interpolate material properties

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature used to interpolate material properties

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/TransientFissionHeatSource.html b/source/kernels/TransientFissionHeatSource.html index a70bb7fa2..6cf9f4963 100644 --- a/source/kernels/TransientFissionHeatSource.html +++ b/source/kernels/TransientFissionHeatSource.html @@ -1,306 +1,521 @@ -TransientFissionHeatSource | Moltres

                                                                                                      TransientFissionHeatSource

                                                                                                      Overview

                                                                                                      This object adds the heat source term of the time-dependent temperature advection-diffusion equation with coupled neutron fluxes from a time-dependent multigroup neutron diffusion calculation.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesAll the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the group fluxes. These MUST be listed by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe total numer of energy groups

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The total numer of energy groups

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      Required Parameters

                                                                                                      • account_decay_heatFalseWhether to account for decay heat.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to account for decay heat.

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • decay_heat_constantsDecay Heat Constants

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay Heat Constants

                                                                                                      • decay_heat_fractionsDecay Heat Fractions

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:Decay Heat Fractions

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • heat_concsAll the variables that hold the decay heat precursor concentrations.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the decay heat precursor concentrations.

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • num_decay_heat_groups0The number of decay heat groups.

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of decay heat groups.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/kernels/VelocityFunctionTemperatureAdvection.html b/source/kernels/VelocityFunctionTemperatureAdvection.html index 1e0de565b..246348b34 100644 --- a/source/kernels/VelocityFunctionTemperatureAdvection.html +++ b/source/kernels/VelocityFunctionTemperatureAdvection.html @@ -1 +1 @@ -VelocityFunctionTemperatureAdvection | Moltres

                                                                                                      VelocityFunctionTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +VelocityFunctionTemperatureAdvection | Moltres

                                                                                                      VelocityFunctionTemperatureAdvection

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The VelocityFunctionTemperatureAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this residual object operates on

                                                                                                        C++ Type:NonlinearVariableName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this residual object operates on

                                                                                                      • vel_x_funcThe x velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The x velocity function

                                                                                                      • vel_y_funcThe y velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The y velocity function

                                                                                                      • vel_z_funcThe z velocity function

                                                                                                        C++ Type:FunctionName

                                                                                                        Controllable:No

                                                                                                        Description:The z velocity function

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • displacementsThe displacements

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The displacements

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

                                                                                                      • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the matrices this Kernel should fill

                                                                                                      • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

                                                                                                        C++ Type:std::vector<TagName>

                                                                                                        Controllable:No

                                                                                                        Description:The extra tags for the vectors this Kernel should fill

                                                                                                      • matrix_tagssystemThe tag for the matrices this Kernel should fill

                                                                                                        Default:system

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, system

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the matrices this Kernel should fill

                                                                                                      • vector_tagsnontimeThe tag for the vectors this Kernel should fill

                                                                                                        Default:nontime

                                                                                                        C++ Type:MultiMooseEnum

                                                                                                        Options:nontime, time

                                                                                                        Controllable:No

                                                                                                        Description:The tag for the vectors this Kernel should fill

                                                                                                      Tagging Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                        C++ Type:std::vector<AuxVariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/materials/CammiFuel.html b/source/materials/CammiFuel.html index 17ba8f40a..80c0bca2e 100644 --- a/source/materials/CammiFuel.html +++ b/source/materials/CammiFuel.html @@ -1,4 +1,4 @@ -CammiFuel | Moltres

                                                                                                      CammiFuel

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CammiFuel has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      • property_tables_rootThe file root name containing interpolation tables for material properties.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file root name containing interpolation tables for material properties.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • controller_gain0.01For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                        Default:0.01

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • fuel_temp_pointsThe fuel temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The fuel temperature interpolation points.

                                                                                                      • materialMust specify either *fuel* or *moderator*.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:Must specify either *fuel* or *moderator*.

                                                                                                      • mod_temp_pointsThe moderator temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The moderator temperature interpolation points.

                                                                                                      • other_temp0If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                      • peak_power_density0The postprocessor which holds the peak power density.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor which holds the peak power density.

                                                                                                      • peak_power_density_set_point10The peak power density set point in W/cm^3

                                                                                                        Default:10

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The peak power density set point in W/cm^3

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/CammiModerator.html b/source/materials/CammiModerator.html index 319ee9298..fadeb7e56 100644 --- a/source/materials/CammiModerator.html +++ b/source/materials/CammiModerator.html @@ -1,4 +1,4 @@ -CammiModerator | Moltres

                                                                                                      CammiModerator

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The CammiModerator has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      • property_tables_rootThe file root name containing interpolation tables for material properties.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file root name containing interpolation tables for material properties.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • controller_gain0.01For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                        Default:0.01

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • fuel_temp_pointsThe fuel temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The fuel temperature interpolation points.

                                                                                                      • materialMust specify either *fuel* or *moderator*.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:Must specify either *fuel* or *moderator*.

                                                                                                      • mod_temp_pointsThe moderator temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The moderator temperature interpolation points.

                                                                                                      • other_temp0If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                      • peak_power_density0The postprocessor which holds the peak power density.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor which holds the peak power density.

                                                                                                      • peak_power_density_set_point10The peak power density set point in W/cm^3

                                                                                                        Default:10

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The peak power density set point in W/cm^3

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/GenericMoltresMaterial.html b/source/materials/GenericMoltresMaterial.html index 6c1f85e48..87f46edf8 100644 --- a/source/materials/GenericMoltresMaterial.html +++ b/source/materials/GenericMoltresMaterial.html @@ -1,155 +1,333 @@ -GenericMoltresMaterial | Moltres

                                                                                                      GenericMoltresMaterial

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The GenericMoltresMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      • property_tables_rootThe file root name containing interpolation tables for material properties.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file root name containing interpolation tables for material properties.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • controller_gain0.01For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                        Default:0.01

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • fuel_temp_pointsThe fuel temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The fuel temperature interpolation points.

                                                                                                      • materialMust specify either *fuel* or *moderator*.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:Must specify either *fuel* or *moderator*.

                                                                                                      • mod_temp_pointsThe moderator temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The moderator temperature interpolation points.

                                                                                                      • other_temp0If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                      • peak_power_density0The postprocessor which holds the peak power density.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor which holds the peak power density.

                                                                                                      • peak_power_density_set_point10The peak power density set point in W/cm^3

                                                                                                        Default:10

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The peak power density set point in W/cm^3

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      Child Objects

                                                                                                      \ No newline at end of file diff --git a/source/materials/GraphiteTwoGrpXSFunctionMaterial.html b/source/materials/GraphiteTwoGrpXSFunctionMaterial.html index 65e006a1a..d29a0cc2c 100644 --- a/source/materials/GraphiteTwoGrpXSFunctionMaterial.html +++ b/source/materials/GraphiteTwoGrpXSFunctionMaterial.html @@ -1,217 +1,236 @@ -GraphiteTwoGrpXSFunctionMaterial | Moltres

                                                                                                      GraphiteTwoGrpXSFunctionMaterial

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The GraphiteTwoGrpXSFunctionMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onSUBDOMAINWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:SUBDOMAIN

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/MoltresJsonMaterial.html b/source/materials/MoltresJsonMaterial.html index 602c1c99e..2eb999d34 100644 --- a/source/materials/MoltresJsonMaterial.html +++ b/source/materials/MoltresJsonMaterial.html @@ -1,4 +1,4 @@ -MoltresJsonMaterial | Moltres

                                                                                                      MoltresJsonMaterial

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      This material class preloads and interpolates JSON-based group constant data provided at various temperature. MoltresJsonMaterial declares the interpolated group constant data as material properties which may be accessed by the neutron diffusion kernels to model a reactor and simulate temperature reactivity feedback. Refer to the "Materials Block" subsection of the Tutorial 2a for more information.

                                                                                                      Table 1: Relevant group constants for neutron energy group or delayed neutron precursor group

                                                                                                      Group constantFormulaLabel
                                                                                                      Macroscopic fission cross sectionFISSXS
                                                                                                      Macroscopic removal cross sectionREMXS
                                                                                                      Macroscopic scattering cross sectionGTRANSFXS
                                                                                                      Neutron diffusion coefficientDIFFCOEF
                                                                                                      Inverse neutron velocityRECIPVEL
                                                                                                      Fission neutron spectrum (total)CHI_T
                                                                                                      Fission neutron spectrum (prompt)CHI_P
                                                                                                      Fission neutron spectrum (delayed)CHI_D
                                                                                                      Effective delayed neutron fractionBETA_EFF
                                                                                                      Delayed neutron precursor decay constantDECAY_CONSTANT

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • base_fileThe file containing macroscopic XS.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file containing macroscopic XS.

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • material_keyThe file key where the macroscopic XS can be found.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file key where the macroscopic XS can be found.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • group_constantsREMXS FISSXS NSF FISSE DIFFCOEF RECIPVEL CHI_T CHI_P CHI_D GTRANSFXS BETA_EFF DECAY_CONSTANT Group constants to be determined.

                                                                                                        Default:REMXS FISSXS NSF FISSE DIFFCOEF RECIPVEL CHI_T CHI_P CHI_D GTRANSFXS BETA_EFF DECAY_CONSTANT

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Group constants to be determined.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html b/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html index 358545acc..92fe09269 100644 --- a/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html +++ b/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html @@ -1,217 +1,236 @@ -MsreFuelTwoGrpXSFunctionMaterial | Moltres

                                                                                                      MsreFuelTwoGrpXSFunctionMaterial

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The MsreFuelTwoGrpXSFunctionMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onSUBDOMAINWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:SUBDOMAIN

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/NuclearMaterial.html b/source/materials/NuclearMaterial.html index c300cffe4..eabf5e906 100644 --- a/source/materials/NuclearMaterial.html +++ b/source/materials/NuclearMaterial.html @@ -1,4 +1,4 @@ -NuclearMaterial | Moltres

                                                                                                      NuclearMaterial

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The NuclearMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Child Objects

                                                                                                      \ No newline at end of file diff --git a/source/materials/Nusselt.html b/source/materials/Nusselt.html index 238a41301..72133ccdf 100644 --- a/source/materials/Nusselt.html +++ b/source/materials/Nusselt.html @@ -1 +1 @@ -Nusselt | Moltres

                                                                                                      Nusselt

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The Nusselt has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • LThe channel radius

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The channel radius

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • k_namekThe name of the thermal conductivity

                                                                                                        Default:k

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the thermal conductivity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      \ No newline at end of file +Nusselt | Moltres

                                                                                                      Nusselt

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The Nusselt has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • LThe channel radius

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The channel radius

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • k_namekThe name of the thermal conductivity

                                                                                                        Default:k

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the thermal conductivity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      \ No newline at end of file diff --git a/source/materials/RoddedMaterial.html b/source/materials/RoddedMaterial.html index fad443b96..ae1875b4c 100644 --- a/source/materials/RoddedMaterial.html +++ b/source/materials/RoddedMaterial.html @@ -1,7 +1,7 @@ -RoddedMaterial | Moltres

                                                                                                      RoddedMaterial

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The RoddedMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Declares material properties based on names and values prescribed by input parameters.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • absorb_factorThe material inherits from some other. How much more absorbing?

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The material inherits from some other. How much more absorbing?

                                                                                                      • interp_typeThe type of interpolation to perform.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:bicubic, spline, monotone_cubic, linear, none, least_squares

                                                                                                        Controllable:No

                                                                                                        Description:The type of interpolation to perform.

                                                                                                      • num_groupsThe number of groups the energy spectrum is divided into.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of groups the energy spectrum is divided into.

                                                                                                      • num_precursor_groupsThe number of delayed neutron precursor groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of delayed neutron precursor groups.

                                                                                                      • prop_namesThe names of the properties this material will have

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:The names of the properties this material will have

                                                                                                      • prop_valuesThe values associated with the named properties

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:Yes

                                                                                                        Description:The values associated with the named properties

                                                                                                      • property_tables_rootThe file root name containing interpolation tables for material properties.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The file root name containing interpolation tables for material properties.

                                                                                                      • rodPositionPosition of the control rod.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Position of the control rod.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • controller_gain0.01For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                        Default:0.01

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:For every W/cm^3 that the peak power density is greater than the peak power density set point, the absorption cross section gets incremented by this amount

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • fuel_temp_pointsThe fuel temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The fuel temperature interpolation points.

                                                                                                      • materialMust specify either *fuel* or *moderator*.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:Must specify either *fuel* or *moderator*.

                                                                                                      • mod_temp_pointsThe moderator temperature interpolation points.

                                                                                                        C++ Type:std::vector<double>

                                                                                                        Controllable:No

                                                                                                        Description:The moderator temperature interpolation points.

                                                                                                      • other_temp0If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:If doing bivariable interpolation, need to supply a postprocessor for the average temperature of the other material.

                                                                                                      • peak_power_density0The postprocessor which holds the peak power density.

                                                                                                        Default:0

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The postprocessor which holds the peak power density.

                                                                                                      • peak_power_density_set_point10The peak power density set point in W/cm^3

                                                                                                        Default:10

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The peak power density set point in W/cm^3

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rodDimensionzDimension that the rod is parallel to.

                                                                                                        Default:z

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:x, y, z

                                                                                                        Controllable:No

                                                                                                        Description:Dimension that the rod is parallel to.

                                                                                                      • sss2_inputTrueWhether serpent 2 was used to generate the input files.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether serpent 2 was used to generate the input files.

                                                                                                      • temperature937.0The temperature field for determining group constants.

                                                                                                        Default:937.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature field for determining group constants.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/SATauMaterial.html b/source/materials/SATauMaterial.html index 635667091..54a00e180 100644 --- a/source/materials/SATauMaterial.html +++ b/source/materials/SATauMaterial.html @@ -1,4 +1,4 @@ -SATauMaterial | Moltres

                                                                                                      SATauMaterial

                                                                                                      This is the material class used to compute the stabilization parameter tau_viscosity for the Spalart-Allmaras turbulent viscosity equation.

                                                                                                      Overview

                                                                                                      This material class computes strong residuals for the Spalart-Allmaras turbulence model equation and adjusts the stabilization parameter for use in pressure-stabilized (PSPG) and streamline-upwind (SUPG) kernels. SATauMaterial includes all functionality from INSADTauMaterial for incompressible Navier-Stokes flow modeling with INSAD kernels from the MOOSE Navier-Stokes physics module.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • pressureThe pressure

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The pressure

                                                                                                      • velocityThe velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The velocity

                                                                                                      • wall_distance_varWall distance aux variable name

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Wall distance aux variable name

                                                                                                      Required Parameters

                                                                                                      • alpha1Multiplicative factor on the stabilization parameter tau.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Multiplicative factor on the stabilization parameter tau.

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • mu_namemuThe name of the dynamic viscosity

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoThe name of the density

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density

                                                                                                      • use_ft2_termFalseWhether to apply the f_t2 term in the equation

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to apply the f_t2 term in the equation

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/materials/SATauStabilized3Eqn.html b/source/materials/SATauStabilized3Eqn.html index 05401e886..c3fc3d4b2 100644 --- a/source/materials/SATauStabilized3Eqn.html +++ b/source/materials/SATauStabilized3Eqn.html @@ -1,4 +1,4 @@ -SATauStabilized 3 Eqn | Moltres

                                                                                                      SATauStabilized3Eqn

                                                                                                      This is the material class used to add the turbulent diffusion strong residual contribution for the stabilization of the energy equation.

                                                                                                      Overview

                                                                                                      This material class computes strong residuals for the temperature advection-diffusion equation and adjusts the stabilization parameter for use in pressure-stabilized (PSPG) and streamline-upwind (SUPG) kernels. SATauStabilized3Eqn includes all functionality from INSADStabilized3Eqn for thermal-hydraulics modeling with INSAD kernels from the MOOSE Navier-Stokes physics module and SATauMaterial for Spalart-Allmaras turbulence modeling.

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • mu_tildeSpalart-Allmaras turbulence viscosity variable

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Spalart-Allmaras turbulence viscosity variable

                                                                                                      • pressureThe pressure

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The pressure

                                                                                                      • temperatureThe temperature

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The temperature

                                                                                                      • velocityThe velocity

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The velocity

                                                                                                      • wall_distance_varWall distance aux variable name

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Wall distance aux variable name

                                                                                                      Required Parameters

                                                                                                      • alpha1Multiplicative factor on the stabilization parameter tau.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Multiplicative factor on the stabilization parameter tau.

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundaries (ids or names) from the mesh where this object applies

                                                                                                      • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

                                                                                                      • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                        Default:NONE

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:NONE, ELEMENT, SUBDOMAIN

                                                                                                        Controllable:No

                                                                                                        Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

                                                                                                      • cp_namecpThe name of the specific heat capacity

                                                                                                        Default:cp

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the specific heat capacity

                                                                                                      • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

                                                                                                      • grad_k_namegrad_kthe name of the gradient of the thermal conductivity material property

                                                                                                        Default:grad_k

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:the name of the gradient of the thermal conductivity material property

                                                                                                      • k_namekthe name of the thermal conductivity material property

                                                                                                        Default:k

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:the name of the thermal conductivity material property

                                                                                                      • mu_namemuThe name of the dynamic viscosity

                                                                                                        Default:mu

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the dynamic viscosity

                                                                                                      • prandtl_number0.85Turbulent Prandtl number

                                                                                                        Default:0.85

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Turbulent Prandtl number

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • rho_namerhoThe name of the density

                                                                                                        Default:rho

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the density

                                                                                                      • use_ft2_termFalseWhether to apply the f_t2 term in the equation

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to apply the f_t2 term in the equation

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

                                                                                                      • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        Default:none

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      Outputs Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/AverageFissionHeat.html b/source/postprocessors/AverageFissionHeat.html index 9283516e0..a82d40a64 100644 --- a/source/postprocessors/AverageFissionHeat.html +++ b/source/postprocessors/AverageFissionHeat.html @@ -1,45 +1,131 @@ -AverageFissionHeat | Moltres

                                                                                                      AverageFissionHeat

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The AverageFissionHeat has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesThe group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of energy groups.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/DivisionPostprocessor.html b/source/postprocessors/DivisionPostprocessor.html index e05d81fb0..0de17cfd7 100644 --- a/source/postprocessors/DivisionPostprocessor.html +++ b/source/postprocessors/DivisionPostprocessor.html @@ -1,317 +1,580 @@ -DivisionPostprocessor | Moltres

                                                                                                      DivisionPostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DivisionPostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Computes the difference between two postprocessors

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • value1First value

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:First value

                                                                                                      • value2Second value

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:Second value

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/ElementL2Diff.html b/source/postprocessors/ElementL2Diff.html index b1bfb6408..b7eb132f0 100644 --- a/source/postprocessors/ElementL2Diff.html +++ b/source/postprocessors/ElementL2Diff.html @@ -1,80 +1,55 @@ -ElementL 2 Diff | Moltres

                                                                                                      ElementL2Diff

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ElementL2Diff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Computes a volume integral of the specified variable

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this object operates on

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html b/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html index 6edb53470..3e7ab9bfb 100644 --- a/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html @@ -1,4 +1,4 @@ -ElmIntegTotFissHeatPostprocessor | Moltres

                                                                                                      ElmIntegTotFissHeatPostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ElmIntegTotFissHeatPostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesThe group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of energy groups.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      Child Objects

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html b/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html index 8e66ad793..5ab7970f2 100644 --- a/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html @@ -1,80 +1,55 @@ -ElmIntegTotFissNtsPostprocessor | Moltres

                                                                                                      ElmIntegTotFissNtsPostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ElmIntegTotFissNtsPostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • account_delayedFalseWhether to account for delayed neutrons.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to account for delayed neutrons.

                                                                                                      • group_fluxesThe group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of energy groups.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • num_precursor_groups0The number of precursor groups.

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of precursor groups.

                                                                                                      • pre_concsAll the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:All the variables that hold the precursor concentrations. These MUST be listed by increasing group number.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/ElmIntegTotFissPostprocessor.html b/source/postprocessors/ElmIntegTotFissPostprocessor.html index c5e4ae094..0ac69ac77 100644 --- a/source/postprocessors/ElmIntegTotFissPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissPostprocessor.html @@ -1,80 +1,55 @@ -ElmIntegTotFissPostprocessor | Moltres

                                                                                                      ElmIntegTotFissPostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ElmIntegTotFissPostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • group_fluxesThe group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The group fluxes. MUST be arranged by decreasing energy/increasing group number.

                                                                                                      • num_groupsThe number of energy groups.

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The number of energy groups.

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • nt_scale1Scaling of the neutron fluxes to aid convergence.

                                                                                                        Default:1

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:Scaling of the neutron fluxes to aid convergence.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      Child Objects

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/IntegralNewVariablePostprocessor.html b/source/postprocessors/IntegralNewVariablePostprocessor.html index 7d6c12f52..58b7e38e5 100644 --- a/source/postprocessors/IntegralNewVariablePostprocessor.html +++ b/source/postprocessors/IntegralNewVariablePostprocessor.html @@ -1,440 +1,468 @@ -IntegralNewVariablePostprocessor | Moltres

                                                                                                      IntegralNewVariablePostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The IntegralNewVariablePostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this object operates on

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/IntegralOldVariablePostprocessor.html b/source/postprocessors/IntegralOldVariablePostprocessor.html index c989423a9..13624ab46 100644 --- a/source/postprocessors/IntegralOldVariablePostprocessor.html +++ b/source/postprocessors/IntegralOldVariablePostprocessor.html @@ -1,317 +1,580 @@ -IntegralOldVariablePostprocessor | Moltres

                                                                                                      IntegralOldVariablePostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The IntegralOldVariablePostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • variableThe name of the variable that this object operates on

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable that this object operates on

                                                                                                      Required Parameters

                                                                                                      • blockThe list of blocks (ids or names) that this object will be applied

                                                                                                        C++ Type:std::vector<SubdomainName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of blocks (ids or names) that this object will be applied

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_exp_formTrueWhether concentrations should be in an expotential/logarithmic format.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether concentrations should be in an expotential/logarithmic format.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Determines whether this object is calculated using an implicit or explicit form

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • seed0The seed for the master random number generator

                                                                                                        Default:0

                                                                                                        C++ Type:unsigned int

                                                                                                        Controllable:No

                                                                                                        Description:The seed for the master random number generator

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/LimitK.html b/source/postprocessors/LimitK.html index 02ade56b4..d5b485dc1 100644 --- a/source/postprocessors/LimitK.html +++ b/source/postprocessors/LimitK.html @@ -1,101 +1,62 @@ -LimitK | Moltres

                                                                                                      LimitK

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The LimitK has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Reports the timestep size

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • cutback_factorHow much to cut the time step if multiplication is too high.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:How much to cut the time step if multiplication is too high.

                                                                                                      • growth_factorHow much to grow the time step if multiplication is ok.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:How much to grow the time step if multiplication is ok.

                                                                                                      • k_postprocessorThe name of the postprocessor providing k values.

                                                                                                        C++ Type:PostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The name of the postprocessor providing k values.

                                                                                                      • k_thresholdThe maximum k value before we start cutting time steps.

                                                                                                        C++ Type:double

                                                                                                        Controllable:No

                                                                                                        Description:The maximum k value before we start cutting time steps.

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/postprocessors/SideWeightedIntegralPostprocessor.html b/source/postprocessors/SideWeightedIntegralPostprocessor.html index bee83f324..fdcc148da 100644 --- a/source/postprocessors/SideWeightedIntegralPostprocessor.html +++ b/source/postprocessors/SideWeightedIntegralPostprocessor.html @@ -1,4 +1,4 @@ -SideWeightedIntegralPostprocessor | Moltres

                                                                                                      SideWeightedIntegralPostprocessor

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The SideWeightedIntegralPostprocessor has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Postprocessor for calculating the weighted integral sum/average of a variable along a boundary

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • variableThe name of the variable which this postprocessor integrates

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable which this postprocessor integrates

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      • weight1.0The weight variable in the weighted integral, e.g. the velocity variable for calculating flow-averaged temperature outflow

                                                                                                        Default:1.0

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:The weight variable in the weighted integral, e.g. the velocity variable for calculating flow-averaged temperature outflow

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      Input Files

                                                                                                      \ No newline at end of file diff --git a/source/userobjects/DenomShapeSideUserObject.html b/source/userobjects/DenomShapeSideUserObject.html index e3d8ac23a..a960104dc 100644 --- a/source/userobjects/DenomShapeSideUserObject.html +++ b/source/userobjects/DenomShapeSideUserObject.html @@ -1 +1 @@ -DenomShapeSideUserObject | Moltres

                                                                                                      DenomShapeSideUserObject

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DenomShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • uCharged specie density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charged specie density.

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • compute_jacobiansTrueCompute Jacobians for coupled variables

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Compute Jacobians for coupled variables

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +DenomShapeSideUserObject | Moltres

                                                                                                      DenomShapeSideUserObject

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The DenomShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • uCharged specie density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charged specie density.

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • compute_jacobiansTrueCompute Jacobians for coupled variables

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Compute Jacobians for coupled variables

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/userobjects/NumShapeSideUserObject.html b/source/userobjects/NumShapeSideUserObject.html index 0c646e71c..a51c8cf76 100644 --- a/source/userobjects/NumShapeSideUserObject.html +++ b/source/userobjects/NumShapeSideUserObject.html @@ -1 +1 @@ -NumShapeSideUserObject | Moltres

                                                                                                      NumShapeSideUserObject

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The NumShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • uCharged species density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charged species density.

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • compute_jacobiansTrueCompute Jacobians for coupled variables

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Compute Jacobians for coupled variables

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +NumShapeSideUserObject | Moltres

                                                                                                      NumShapeSideUserObject

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The NumShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • boundaryThe list of boundary IDs from the mesh where this object applies

                                                                                                        C++ Type:std::vector<BoundaryName>

                                                                                                        Controllable:No

                                                                                                        Description:The list of boundary IDs from the mesh where this object applies

                                                                                                      • uCharged species density.

                                                                                                        C++ Type:std::vector<VariableName>

                                                                                                        Controllable:No

                                                                                                        Description:Charged species density.

                                                                                                      Required Parameters

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • compute_jacobiansTrueCompute Jacobians for coupled variables

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Compute Jacobians for coupled variables

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/vectorpostprocessors/ChannelGradient.html b/source/vectorpostprocessors/ChannelGradient.html index 0e3e4a5e4..a2481d2fd 100644 --- a/source/vectorpostprocessors/ChannelGradient.html +++ b/source/vectorpostprocessors/ChannelGradient.html @@ -1 +1 @@ -ChannelGradient | Moltres

                                                                                                      ChannelGradient

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ChannelGradient has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Takes the difference between two line value samplers; useful for calculating macroscopically averaged gradients

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • axisWhat coordinate axis we're sampling along.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:x, y, z

                                                                                                        Controllable:No

                                                                                                        Description:What coordinate axis we're sampling along.

                                                                                                      • lv1The line value sampler that will be on the LHS of the difference operation

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The line value sampler that will be on the LHS of the difference operation

                                                                                                      • lv2The line value sampler that will be on the RHS of the difference operation

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The line value sampler that will be on the RHS of the difference operation

                                                                                                      • var1The name of the variable for the first line value sampler.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable for the first line value sampler.

                                                                                                      • var2The name of the variable for the second line value sampler.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable for the second line value sampler.

                                                                                                      Required Parameters

                                                                                                      • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

                                                                                                        Default:REPLICATED

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:DISTRIBUTED, REPLICATED

                                                                                                        Controllable:No

                                                                                                        Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +ChannelGradient | Moltres

                                                                                                      ChannelGradient

                                                                                                      buildconstruction:Undocumented Class

                                                                                                      The ChannelGradient has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Takes the difference between two line value samplers; useful for calculating macroscopically averaged gradients

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Input Parameters

                                                                                                      • axisWhat coordinate axis we're sampling along.

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:x, y, z

                                                                                                        Controllable:No

                                                                                                        Description:What coordinate axis we're sampling along.

                                                                                                      • lv1The line value sampler that will be on the LHS of the difference operation

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The line value sampler that will be on the LHS of the difference operation

                                                                                                      • lv2The line value sampler that will be on the RHS of the difference operation

                                                                                                        C++ Type:VectorPostprocessorName

                                                                                                        Controllable:No

                                                                                                        Description:The line value sampler that will be on the RHS of the difference operation

                                                                                                      • var1The name of the variable for the first line value sampler.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable for the first line value sampler.

                                                                                                      • var2The name of the variable for the second line value sampler.

                                                                                                        C++ Type:std::string

                                                                                                        Controllable:No

                                                                                                        Description:The name of the variable for the second line value sampler.

                                                                                                      Required Parameters

                                                                                                      • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

                                                                                                      • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                        Default:TIMESTEP_END

                                                                                                        C++ Type:ExecFlagEnum

                                                                                                        Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

                                                                                                        Controllable:No

                                                                                                        Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

                                                                                                      • parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

                                                                                                        Default:REPLICATED

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:DISTRIBUTED, REPLICATED

                                                                                                        Controllable:No

                                                                                                        Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

                                                                                                      • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                        C++ Type:MaterialPropertyName

                                                                                                        Controllable:No

                                                                                                        Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

                                                                                                      • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

                                                                                                      Optional Parameters

                                                                                                      • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

                                                                                                      • control_tagsAdds user-defined labels for accessing object parameters via control logic.

                                                                                                        C++ Type:std::vector<std::string>

                                                                                                        Controllable:No

                                                                                                        Description:Adds user-defined labels for accessing object parameters via control logic.

                                                                                                      • enableTrueSet the enabled status of the MooseObject.

                                                                                                        Default:True

                                                                                                        C++ Type:bool

                                                                                                        Controllable:Yes

                                                                                                        Description:Set the enabled status of the MooseObject.

                                                                                                      • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                        Default:0

                                                                                                        C++ Type:int

                                                                                                        Controllable:No

                                                                                                        Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

                                                                                                      • force_postauxFalseForces the UserObject to be executed in POSTAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in POSTAUX

                                                                                                      • force_preauxFalseForces the UserObject to be executed in PREAUX

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREAUX

                                                                                                      • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Forces the UserObject to be executed in PREIC during initial setup

                                                                                                      • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                        C++ Type:std::vector<OutputName>

                                                                                                        Controllable:No

                                                                                                        Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

                                                                                                      • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/syntax/Nt/index.html b/syntax/Nt/index.html index 905558d45..7f8922eb2 100644 --- a/syntax/Nt/index.html +++ b/syntax/Nt/index.html @@ -1 +1 @@ -Nt System | Moltres

                                                                                                      Nt System

                                                                                                      buildconstruction:Undocumented System

                                                                                                      The Nt system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Available Actions

                                                                                                      \ No newline at end of file +Nt System | Moltres

                                                                                                      Nt System

                                                                                                      buildconstruction:Undocumented System

                                                                                                      The Nt system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Available Actions

                                                                                                      \ No newline at end of file diff --git a/syntax/Precursors/index.html b/syntax/Precursors/index.html index bff2934b5..3df968959 100644 --- a/syntax/Precursors/index.html +++ b/syntax/Precursors/index.html @@ -1 +1 @@ -Precursors System | Moltres

                                                                                                      Precursors System

                                                                                                      buildconstruction:Undocumented System

                                                                                                      The Precursors system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Available Actions

                                                                                                      \ No newline at end of file +Precursors System | Moltres

                                                                                                      Precursors System

                                                                                                      buildconstruction:Undocumented System

                                                                                                      The Precursors system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                      Overview

                                                                                                      Example Input File Syntax

                                                                                                      Available Actions

                                                                                                      \ No newline at end of file diff --git a/syntax/index.html b/syntax/index.html index aa77c4d5f..97edc4ff5 100644 --- a/syntax/index.html +++ b/syntax/index.html @@ -1 +1 @@ -Complete Syntax | Moltres

                                                                                                      Complete Syntax

                                                                                                      actions

                                                                                                        auxkernels

                                                                                                        bcs

                                                                                                        dgkernels

                                                                                                        dirackernels

                                                                                                            interface_kernels

                                                                                                                kernels

                                                                                                                materials

                                                                                                                postprocessors

                                                                                                                userobjects

                                                                                                                  vectorpostprocessors

                                                                                                                      \ No newline at end of file +Complete Syntax | Moltres

                                                                                                                      Complete Syntax

                                                                                                                      actions

                                                                                                                        auxkernels

                                                                                                                        bcs

                                                                                                                        dgkernels

                                                                                                                        dirackernels

                                                                                                                            interface_kernels

                                                                                                                                kernels

                                                                                                                                materials

                                                                                                                                postprocessors

                                                                                                                                userobjects

                                                                                                                                  vectorpostprocessors

                                                                                                                                      \ No newline at end of file