From ec4f7720c1f817a77cecf5e572cb1108164928df Mon Sep 17 00:00:00 2001 From: smpark7 Date: Mon, 16 Sep 2024 18:16:16 +0000 Subject: [PATCH] Merge pull request #276 from nglaser3/issue_fixes Change default behavior of exponential form parameter c04cc19414749b40acd187431824559498693cca --- 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 | 10 +- source/actions/PrecursorAction.html | 2 +- source/auxkernels/ConstantDifferenceAux.html | 238 +- source/auxkernels/Density.html | 2 +- source/auxkernels/FissionHeatSourceAux.html | 2564 +- .../FissionHeatSourceTransientAux.html | 4480 +- source/auxkernels/FunctionDerivativeAux.html | 2 +- source/auxkernels/MatDiffusionAux.html | 1598 +- .../ModeratorHeatSourceTransientAux.html | 3662 +- .../auxkernels/SATurbulentViscosityAux.html | 880 +- source/auxkernels/TurbulentStressAux.html | 880 +- source/auxkernels/WallDistanceAux.html | 880 +- source/auxkernels/WallShearStressAux.html | 880 +- 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 | 880 +- source/bcs/INSADMomentumSUPGBC.html | 880 +- source/bcs/INSADMomentumTurbulentNoBCBC.html | 880 +- source/bcs/InflowBC.html | 2 +- source/bcs/LinLogPenaltyDirichletBC.html | 10 +- 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 | 880 +- source/bcs/SATurbulentViscositySUPGBC.html | 880 +- source/bcs/ScalarAdvectionArtDiffNoBCBC.html | 440 +- source/bcs/TemperatureInflowBC.html | 2 +- source/bcs/TemperatureOutflowBC.html | 2 +- source/bcs/VacuumConcBC.html | 19840 ++++----- 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 | 184 +- source/dirackernels/DiracHX.html | 322 +- .../InterTemperatureAdvection.html | 2 +- .../ConservativeTemperatureAdvection.html | 2 +- source/kernels/ConvectiveHeatExchanger.html | 1198 +- source/kernels/CoupledFissionKernel.html | 15626 +++---- source/kernels/CoupledScalarAdvection.html | 4 +- source/kernels/CtrlConservativeAdvection.html | 2 +- .../CtrlConservativeTemperatureAdvection.html | 2 +- source/kernels/DecayHeatSource.html | 2 +- source/kernels/DelayedNeutronSource.html | 10708 ++--- .../DivFreeCoupledScalarAdvection.html | 2 +- source/kernels/FissionHeatSource.html | 2162 +- source/kernels/GammaHeatSource.html | 16048 +++---- source/kernels/GroupDiffusion.html | 25660 +++++------ source/kernels/HeatPrecursorDecay.html | 4 +- source/kernels/HeatPrecursorSource.html | 4 +- .../INSADEnergyTurbulentDiffusion.html | 178 +- .../INSADMomentumTurbulentViscous.html | 880 +- source/kernels/INSBoussinesqBodyForce.html | 1766 +- source/kernels/InScatter.html | 24162 +++++------ .../MatINSTemperatureTimeDerivative.html | 2 +- source/kernels/NonConservativeAdvection.html | 2 +- source/kernels/NtTimeDerivative.html | 16198 +++---- source/kernels/PotentialAdvection.html | 2 +- source/kernels/PrecursorDecay.html | 4 +- source/kernels/PrecursorSource.html | 4 +- source/kernels/SATimeDerivative.html | 880 +- source/kernels/SATurbulentViscosity.html | 880 +- source/kernels/ScalarAdvectionArtDiff.html | 1382 +- .../ScalarTransportTimeDerivative.html | 6 +- source/kernels/SigmaR.html | 27158 ++++++------ .../kernels/TransientFissionHeatSource.html | 20294 ++++----- .../VelocityFunctionTemperatureAdvection.html | 2 +- source/materials/CammiFuel.html | 3640 +- source/materials/CammiModerator.html | 3640 +- source/materials/GenericMoltresMaterial.html | 35494 ++++++++-------- .../GraphiteTwoGrpXSFunctionMaterial.html | 1260 +- source/materials/MoltresJsonMaterial.html | 1544 +- .../MsreFuelTwoGrpXSFunctionMaterial.html | 1260 +- source/materials/NuclearMaterial.html | 6 +- source/materials/Nusselt.html | 2 +- source/materials/RoddedMaterial.html | 474 +- source/materials/SATauMaterial.html | 780 +- source/materials/SATauStabilized3Eqn.html | 178 +- source/postprocessors/AverageFissionHeat.html | 12744 +++--- .../postprocessors/DivisionPostprocessor.html | 20246 ++++----- source/postprocessors/ElementL2Diff.html | 12212 +++--- .../ElmIntegTotFissHeatPostprocessor.html | 3038 +- .../ElmIntegTotFissNtsPostprocessor.html | 13372 +++--- .../ElmIntegTotFissPostprocessor.html | 12058 +++--- .../IntegralNewVariablePostprocessor.html | 19854 ++++----- .../IntegralOldVariablePostprocessor.html | 20246 ++++----- source/postprocessors/LimitK.html | 916 +- .../SideWeightedIntegralPostprocessor.html | 24 +- .../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, 185321 insertions(+), 185321 deletions(-) diff --git a/citing.html b/citing.html index ef2533b80..c6f0af051 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 7d6dad87a..a43c860fc 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 2fb3f0a62..800627630 100644
--- a/doxygen/_average_fission_heat_8_c.html
+++ b/doxygen/_average_fission_heat_8_c.html
@@ -129,7 +129,7 @@ 

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8
+Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
 

 
 
diff --git a/doxygen/_average_fission_heat_8h.html b/doxygen/_average_fission_heat_8h.html
index 75ced0779..567782fe8 100644
--- a/doxygen/_average_fission_heat_8h.html
+++ b/doxygen/_average_fission_heat_8h.html
@@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2babd1c61..a036cc2ec 100644 --- a/doxygen/_average_fission_heat_8h_source.html +++ b/doxygen/_average_fission_heat_8h_source.html @@ -125,7 +125,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8_c.html b/doxygen/_cammi_fuel_8_c.html index 0a5743104..607e18d65 100644 --- a/doxygen/_cammi_fuel_8_c.html +++ b/doxygen/_cammi_fuel_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8h.html b/doxygen/_cammi_fuel_8h.html index b175f579f..737b41f07 100644 --- a/doxygen/_cammi_fuel_8h.html +++ b/doxygen/_cammi_fuel_8h.html @@ -109,7 +109,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_fuel_8h_source.html b/doxygen/_cammi_fuel_8h_source.html index 2f860d4db..f89a0f2ca 100644 --- a/doxygen/_cammi_fuel_8h_source.html +++ b/doxygen/_cammi_fuel_8h_source.html @@ -119,7 +119,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8_c.html b/doxygen/_cammi_moderator_8_c.html index 5ef26f645..9b30bb702 100644 --- a/doxygen/_cammi_moderator_8_c.html +++ b/doxygen/_cammi_moderator_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8h.html b/doxygen/_cammi_moderator_8h.html index f5a88e6a4..d8f4dbcb1 100644 --- a/doxygen/_cammi_moderator_8h.html +++ b/doxygen/_cammi_moderator_8h.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_cammi_moderator_8h_source.html b/doxygen/_cammi_moderator_8h_source.html index 478d33713..225c8607a 100644 --- a/doxygen/_cammi_moderator_8h_source.html +++ b/doxygen/_cammi_moderator_8h_source.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c7cbb1097..20a6cbba2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7054e41bf..2f3027c28 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 feaba8b58..52a55f234 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 25ad07fd3..101f1b041 100644 --- a/doxygen/_constant_difference_aux_8_c.html +++ b/doxygen/_constant_difference_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_constant_difference_aux_8h.html b/doxygen/_constant_difference_aux_8h.html index f43dd3004..836abf022 100644 --- a/doxygen/_constant_difference_aux_8h.html +++ b/doxygen/_constant_difference_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b77b5dbb3..2c2e5864e 100644 --- a/doxygen/_constant_difference_aux_8h_source.html +++ b/doxygen/_constant_difference_aux_8h_source.html @@ -115,7 +115,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0718b848d..b2a6a95e9 100644 --- a/doxygen/_convective_heat_exchanger_8_c.html +++ b/doxygen/_convective_heat_exchanger_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_convective_heat_exchanger_8h.html b/doxygen/_convective_heat_exchanger_8h.html index b11e13af4..60eced43a 100644 --- a/doxygen/_convective_heat_exchanger_8h.html +++ b/doxygen/_convective_heat_exchanger_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3b7e54e3b..7a012a0b6 100644 --- a/doxygen/_convective_heat_exchanger_8h_source.html +++ b/doxygen/_convective_heat_exchanger_8h_source.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ff2f08a5a..7b203c4aa 100644 --- a/doxygen/_coupled_fission_kernel_8_c.html +++ b/doxygen/_coupled_fission_kernel_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_fission_kernel_8h.html b/doxygen/_coupled_fission_kernel_8h.html index f3897d179..2e78e73a0 100644 --- a/doxygen/_coupled_fission_kernel_8h.html +++ b/doxygen/_coupled_fission_kernel_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 be54bdf12..c0e89d2f9 100644 --- a/doxygen/_coupled_fission_kernel_8h_source.html +++ b/doxygen/_coupled_fission_kernel_8h_source.html @@ -150,7 +150,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 652cc3591..475a538c6 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f19e89b93..cec00893b 100644 --- a/doxygen/_coupled_outflow_b_c_8h.html +++ b/doxygen/_coupled_outflow_b_c_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 004219dd6..cbf29bd3c 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a271ca0e1..47da206ae 100644 --- a/doxygen/_coupled_scalar_advection_8_c.html +++ b/doxygen/_coupled_scalar_advection_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_coupled_scalar_advection_8h.html b/doxygen/_coupled_scalar_advection_8h.html index 556e671a5..de1d8bd91 100644 --- a/doxygen/_coupled_scalar_advection_8h.html +++ b/doxygen/_coupled_scalar_advection_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 41767b46f..e0190ee40 100644 --- a/doxygen/_coupled_scalar_advection_8h_source.html +++ b/doxygen/_coupled_scalar_advection_8h_source.html @@ -146,7 +146,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 36eac222c..05f7dbe53 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 abb523ac3..2ad679054 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 01f8102c5..20dc12c8f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ff9bc8f1c..bb3b598a2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d0ec3d083..1205c8f39 100644 --- a/doxygen/_d_g_turbulent_diffusion_8h.html +++ b/doxygen/_d_g_turbulent_diffusion_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 621e94c5c..ff6c6b040 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d4f927720..f639e46a8 100644 --- a/doxygen/_decay_heat_source_8_c.html +++ b/doxygen/_decay_heat_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_decay_heat_source_8h.html b/doxygen/_decay_heat_source_8h.html index 61710333f..ce3dd9deb 100644 --- a/doxygen/_decay_heat_source_8h.html +++ b/doxygen/_decay_heat_source_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 cb9074a16..72e7f1292 100644 --- a/doxygen/_decay_heat_source_8h_source.html +++ b/doxygen/_decay_heat_source_8h_source.html @@ -126,7 +126,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 97e5cedbf..e03aa18a9 100644 --- a/doxygen/_delayed_neutron_source_8_c.html +++ b/doxygen/_delayed_neutron_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_delayed_neutron_source_8h.html b/doxygen/_delayed_neutron_source_8h.html index 14c9db1e2..796870df5 100644 --- a/doxygen/_delayed_neutron_source_8h.html +++ b/doxygen/_delayed_neutron_source_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 dd45076cc..994a78f72 100644 --- a/doxygen/_delayed_neutron_source_8h_source.html +++ b/doxygen/_delayed_neutron_source_8h_source.html @@ -138,7 +138,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 567f18f0a..d33ac2e7d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 78ce2028e..ceeabaa4e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0ce67ef0a..a41258320 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1c1e9c239..b11162f22 100644 --- a/doxygen/_dirac_h_x_8_c.html +++ b/doxygen/_dirac_h_x_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_dirac_h_x_8h.html b/doxygen/_dirac_h_x_8h.html index 2e6d0e6fc..e7420b30d 100644 --- a/doxygen/_dirac_h_x_8h.html +++ b/doxygen/_dirac_h_x_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 088c05cff..05ad4f37a 100644 --- a/doxygen/_dirac_h_x_8h_source.html +++ b/doxygen/_dirac_h_x_8h_source.html @@ -118,7 +118,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 57a742e1b..be897807e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1e932213c..79ce556bb 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 dd9f3d8f6..7e9c32819 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8_c.html b/doxygen/_division_postprocessor_8_c.html index 563d95e0b..c48760e5d 100644 --- a/doxygen/_division_postprocessor_8_c.html +++ b/doxygen/_division_postprocessor_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8h.html b/doxygen/_division_postprocessor_8h.html index 867690e1d..9006da04d 100644 --- a/doxygen/_division_postprocessor_8h.html +++ b/doxygen/_division_postprocessor_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_division_postprocessor_8h_source.html b/doxygen/_division_postprocessor_8h_source.html index b2be191e0..4739c3cba 100644 --- a/doxygen/_division_postprocessor_8h_source.html +++ b/doxygen/_division_postprocessor_8h_source.html @@ -112,7 +112,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8428e7d6b..e4a116b48 100644 --- a/doxygen/_element_l2_diff_8_c.html +++ b/doxygen/_element_l2_diff_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_element_l2_diff_8h.html b/doxygen/_element_l2_diff_8h.html index 3f38555c0..d5e5b474f 100644 --- a/doxygen/_element_l2_diff_8h.html +++ b/doxygen/_element_l2_diff_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 605b3ede7..538721983 100644 --- a/doxygen/_element_l2_diff_8h_source.html +++ b/doxygen/_element_l2_diff_8h_source.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1f9ee06b9..f18f26bc2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a9d75389d..92c47ff48 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f12486d2d..bc003a7c8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 97ef9244f..79c2e9f5e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 59ff3acd0..9679e076a 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 98e01cb70..54872790f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c5c0df4a6..d37e8022e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b6568717c..e648317ee 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8ad884858..5f686bee1 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a20c9bc12..48bf51a45 100644 --- a/doxygen/_fission_heat_source_8_c.html +++ b/doxygen/_fission_heat_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_fission_heat_source_8h.html b/doxygen/_fission_heat_source_8h.html index 9a65d6108..a6d59eb34 100644 --- a/doxygen/_fission_heat_source_8h.html +++ b/doxygen/_fission_heat_source_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e0fead66d..aeb059888 100644 --- a/doxygen/_fission_heat_source_8h_source.html +++ b/doxygen/_fission_heat_source_8h_source.html @@ -133,7 +133,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 50952ec04..d9c088bc5 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 73f73099e..9af569465 100644 --- a/doxygen/_fission_heat_source_aux_8h.html +++ b/doxygen/_fission_heat_source_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2daae8ec2..426bb06e8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 5006218d7..f52365e2b 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 503fae219..4b0b5485d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 95a609b75..ec46700df 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 05367e47f..1689d5773 100644 --- a/doxygen/_gamma_heat_source_8_c.html +++ b/doxygen/_gamma_heat_source_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_gamma_heat_source_8h.html b/doxygen/_gamma_heat_source_8h.html index a146f160d..5286ba212 100644 --- a/doxygen/_gamma_heat_source_8h.html +++ b/doxygen/_gamma_heat_source_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7182466a8..e22758e8a 100644 --- a/doxygen/_gamma_heat_source_8h_source.html +++ b/doxygen/_gamma_heat_source_8h_source.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b8a142391..4459d9cc0 100644 --- a/doxygen/_generic_moltres_material_8_c.html +++ b/doxygen/_generic_moltres_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_generic_moltres_material_8h.html b/doxygen/_generic_moltres_material_8h.html index 06b8714ea..703087f81 100644 --- a/doxygen/_generic_moltres_material_8h.html +++ b/doxygen/_generic_moltres_material_8h.html @@ -111,7 +111,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ecc670bfc..bc387418f 100644 --- a/doxygen/_generic_moltres_material_8h_source.html +++ b/doxygen/_generic_moltres_material_8h_source.html @@ -150,7 +150,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b7f50e028..915d496e2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 4c3ebaa4e..4ac867493 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ed7167e0a..f8e58cbf8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8_c.html b/doxygen/_group_diffusion_8_c.html index 0386d1d89..bba5d7b54 100644 --- a/doxygen/_group_diffusion_8_c.html +++ b/doxygen/_group_diffusion_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8h.html b/doxygen/_group_diffusion_8h.html index eedde179c..ab8001a8c 100644 --- a/doxygen/_group_diffusion_8h.html +++ b/doxygen/_group_diffusion_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_group_diffusion_8h_source.html b/doxygen/_group_diffusion_8h_source.html index f5e4681d2..e502ee7ac 100644 --- a/doxygen/_group_diffusion_8h_source.html +++ b/doxygen/_group_diffusion_8h_source.html @@ -126,7 +126,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8a052a92b..4bce89173 100644 --- a/doxygen/_heat_precursor_decay_8_c.html +++ b/doxygen/_heat_precursor_decay_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_decay_8h.html b/doxygen/_heat_precursor_decay_8h.html index f4e8751e5..a597f4a5a 100644 --- a/doxygen/_heat_precursor_decay_8h.html +++ b/doxygen/_heat_precursor_decay_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c0acb9333..e0cae6a6a 100644 --- a/doxygen/_heat_precursor_decay_8h_source.html +++ b/doxygen/_heat_precursor_decay_8h_source.html @@ -120,7 +120,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1efaa2e70..8eebadcd3 100644 --- a/doxygen/_heat_precursor_source_8_c.html +++ b/doxygen/_heat_precursor_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_heat_precursor_source_8h.html b/doxygen/_heat_precursor_source_8h.html index 33a36921d..6eb81ad2f 100644 --- a/doxygen/_heat_precursor_source_8h.html +++ b/doxygen/_heat_precursor_source_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 066983e23..7e3072bc1 100644 --- a/doxygen/_heat_precursor_source_8h_source.html +++ b/doxygen/_heat_precursor_source_8h_source.html @@ -146,7 +146,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2a818eb29..a5bbb350d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 fae5b99c0..88bdb2ad6 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 bb637aa54..a6a251ca8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 fc774b06d..3034e4b04 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d011e2a34..814e4acee 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 72012b5f5..fc35c5dad 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e928f8d75..5f1c57611 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8c7fc827e..c08b296e4 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c010611c4..88c33f2df 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 81ca53c64..2f237f490 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 490d3fe22..966e9ada5 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1e7d229f4..75feb6ea1 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2cb4da30b..88f4a7c6b 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 eea97e0f0..d276a04c2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 768c6e470..784d7acce 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a5a493b72..9c72ebb8d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 268ff7bb1..0af9ab106 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e371eb65b..ae9de86d7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8_c.html b/doxygen/_in_scatter_8_c.html index 1bf3091d7..a9d4a893d 100644 --- a/doxygen/_in_scatter_8_c.html +++ b/doxygen/_in_scatter_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8h.html b/doxygen/_in_scatter_8h.html index 75602e7ac..09142e1eb 100644 --- a/doxygen/_in_scatter_8h.html +++ b/doxygen/_in_scatter_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_in_scatter_8h_source.html b/doxygen/_in_scatter_8h_source.html index 46c57cff9..e5c9ce5b4 100644 --- a/doxygen/_in_scatter_8h_source.html +++ b/doxygen/_in_scatter_8h_source.html @@ -134,7 +134,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 06717cc97..551fe99d2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7f7ca30ac..7fdb14a92 100644 --- a/doxygen/_integral_new_variable_postprocessor_8h.html +++ b/doxygen/_integral_new_variable_postprocessor_8h.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 30051a74e..f748f9bac 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c8b87e9de..cd3fd3df4 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b4b93bf61..90b35b4f9 100644 --- a/doxygen/_integral_old_variable_postprocessor_8h.html +++ b/doxygen/_integral_old_variable_postprocessor_8h.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b1159b6b2..4c2fe6642 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8_c.html b/doxygen/_limit_k_8_c.html index 65a74e9ec..87720e7e5 100644 --- a/doxygen/_limit_k_8_c.html +++ b/doxygen/_limit_k_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8h.html b/doxygen/_limit_k_8h.html index f16ec0261..dd767e412 100644 --- a/doxygen/_limit_k_8h.html +++ b/doxygen/_limit_k_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_limit_k_8h_source.html b/doxygen/_limit_k_8h_source.html index f10c542db..e128b397c 100644 --- a/doxygen/_limit_k_8h_source.html +++ b/doxygen/_limit_k_8h_source.html @@ -139,7 +139,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 32f95958a..48c39e68a 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3987cdbf1..337cfd717 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 47888b6f4..e9a97d9ba 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 9f4d000d2..873bd5b30 100644 --- a/doxygen/_mat_diffusion_aux_8_c.html +++ b/doxygen/_mat_diffusion_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_mat_diffusion_aux_8h.html b/doxygen/_mat_diffusion_aux_8h.html index 5ebec638c..43f59c321 100644 --- a/doxygen/_mat_diffusion_aux_8h.html +++ b/doxygen/_mat_diffusion_aux_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2465bdc0c..d9c90d11a 100644 --- a/doxygen/_mat_diffusion_aux_8h_source.html +++ b/doxygen/_mat_diffusion_aux_8h_source.html @@ -118,7 +118,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 bbad4e3cd..bae413280 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 63006b406..9dac5daf2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 27adfaf1d..e482af3f1 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c4a4731cc..1f8cc2878 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 33209c25d..33e6d0b06 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8d0152b57..6276aba86 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8_c.html b/doxygen/_moltres_app_8_c.html index 29de6d584..cd087784a 100644 --- a/doxygen/_moltres_app_8_c.html +++ b/doxygen/_moltres_app_8_c.html @@ -179,7 +179,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8h.html b/doxygen/_moltres_app_8h.html index 805e8ae50..62422106f 100644 --- a/doxygen/_moltres_app_8h.html +++ b/doxygen/_moltres_app_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_app_8h_source.html b/doxygen/_moltres_app_8h_source.html index 613605c27..ea6ee30bf 100644 --- a/doxygen/_moltres_app_8h_source.html +++ b/doxygen/_moltres_app_8h_source.html @@ -114,7 +114,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 493b141e5..495eae100 100644 --- a/doxygen/_moltres_json_material_8_c.html +++ b/doxygen/_moltres_json_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_moltres_json_material_8h.html b/doxygen/_moltres_json_material_8h.html index 4635761f9..2b8560ff2 100644 --- a/doxygen/_moltres_json_material_8h.html +++ b/doxygen/_moltres_json_material_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ebe6a051c..7f538baf0 100644 --- a/doxygen/_moltres_json_material_8h_source.html +++ b/doxygen/_moltres_json_material_8h_source.html @@ -123,7 +123,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 34cd93c3d..7fc5b754c 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 029c2e9c5..e3554009e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c1383a08f..8f330882d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8_c.html b/doxygen/_neutron_leakage_8_c.html index da404b749..ed8066d07 100644 --- a/doxygen/_neutron_leakage_8_c.html +++ b/doxygen/_neutron_leakage_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8h.html b/doxygen/_neutron_leakage_8h.html index e9e623418..1dd7507a4 100644 --- a/doxygen/_neutron_leakage_8h.html +++ b/doxygen/_neutron_leakage_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_neutron_leakage_8h_source.html b/doxygen/_neutron_leakage_8h_source.html index a1731c55e..e2b9a9c32 100644 --- a/doxygen/_neutron_leakage_8h_source.html +++ b/doxygen/_neutron_leakage_8h_source.html @@ -115,7 +115,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8_c.html b/doxygen/_nt_action_8_c.html index 4377f62ca..40ae2d9d7 100644 --- a/doxygen/_nt_action_8_c.html +++ b/doxygen/_nt_action_8_c.html @@ -395,7 +395,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8h.html b/doxygen/_nt_action_8h.html index 8704673e0..0ca9595e3 100644 --- a/doxygen/_nt_action_8h.html +++ b/doxygen/_nt_action_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_action_8h_source.html b/doxygen/_nt_action_8h_source.html index a16915a25..8674cb95a 100644 --- a/doxygen/_nt_action_8h_source.html +++ b/doxygen/_nt_action_8h_source.html @@ -135,7 +135,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2d9096604..8475d4998 100644 --- a/doxygen/_nt_time_derivative_8_c.html +++ b/doxygen/_nt_time_derivative_8_c.html @@ -131,7 +131,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nt_time_derivative_8h.html b/doxygen/_nt_time_derivative_8h.html index a3ed39c00..aa439e094 100644 --- a/doxygen/_nt_time_derivative_8h.html +++ b/doxygen/_nt_time_derivative_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 077967fbe..eebd0c098 100644 --- a/doxygen/_nt_time_derivative_8h_source.html +++ b/doxygen/_nt_time_derivative_8h_source.html @@ -125,7 +125,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8_c.html b/doxygen/_nuclear_material_8_c.html index 08ff7608e..6ca229b26 100644 --- a/doxygen/_nuclear_material_8_c.html +++ b/doxygen/_nuclear_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8h.html b/doxygen/_nuclear_material_8h.html index f523da7f0..e71fb642f 100644 --- a/doxygen/_nuclear_material_8h.html +++ b/doxygen/_nuclear_material_8h.html @@ -112,7 +112,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nuclear_material_8h_source.html b/doxygen/_nuclear_material_8h_source.html index e9aca7952..fb744dcc7 100644 --- a/doxygen/_nuclear_material_8h_source.html +++ b/doxygen/_nuclear_material_8h_source.html @@ -288,7 +288,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8_c.html b/doxygen/_nusselt_8_c.html index 8083eaf51..22df77297 100644 --- a/doxygen/_nusselt_8_c.html +++ b/doxygen/_nusselt_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8h.html b/doxygen/_nusselt_8h.html index dc790194e..9b5e87564 100644 --- a/doxygen/_nusselt_8h.html +++ b/doxygen/_nusselt_8h.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_nusselt_8h_source.html b/doxygen/_nusselt_8h_source.html index a739bfadd..22a013ca1 100644 --- a/doxygen/_nusselt_8h_source.html +++ b/doxygen/_nusselt_8h_source.html @@ -121,7 +121,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e2c38bf58..4f7fd2d53 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3cfed0d6c..5150b6e3f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 89e49e652..074d8d1c9 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8_c.html b/doxygen/_precursor_action_8_c.html index 9e154c113..7e284986a 100644 --- a/doxygen/_precursor_action_8_c.html +++ b/doxygen/_precursor_action_8_c.html @@ -429,7 +429,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8h.html b/doxygen/_precursor_action_8h.html index 87a83240c..ee0ee3275 100644 --- a/doxygen/_precursor_action_8h.html +++ b/doxygen/_precursor_action_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_action_8h_source.html b/doxygen/_precursor_action_8h_source.html index 8db26c008..e6ab04675 100644 --- a/doxygen/_precursor_action_8h_source.html +++ b/doxygen/_precursor_action_8h_source.html @@ -167,7 +167,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8_c.html b/doxygen/_precursor_decay_8_c.html index 2b4e421ea..268da8e10 100644 --- a/doxygen/_precursor_decay_8_c.html +++ b/doxygen/_precursor_decay_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8h.html b/doxygen/_precursor_decay_8h.html index 1425f2509..121a2be75 100644 --- a/doxygen/_precursor_decay_8h.html +++ b/doxygen/_precursor_decay_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_decay_8h_source.html b/doxygen/_precursor_decay_8h_source.html index 0abad9782..c46a2f58d 100644 --- a/doxygen/_precursor_decay_8h_source.html +++ b/doxygen/_precursor_decay_8h_source.html @@ -130,7 +130,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8_c.html b/doxygen/_precursor_source_8_c.html index 510a39cd0..dcf41243f 100644 --- a/doxygen/_precursor_source_8_c.html +++ b/doxygen/_precursor_source_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8h.html b/doxygen/_precursor_source_8h.html index 6510bd0ef..01d783328 100644 --- a/doxygen/_precursor_source_8h.html +++ b/doxygen/_precursor_source_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_precursor_source_8h_source.html b/doxygen/_precursor_source_8h_source.html index a16a111cb..1ae55ad19 100644 --- a/doxygen/_precursor_source_8h_source.html +++ b/doxygen/_precursor_source_8h_source.html @@ -142,7 +142,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8_c.html b/doxygen/_rodded_material_8_c.html index 07170e061..f06385fd9 100644 --- a/doxygen/_rodded_material_8_c.html +++ b/doxygen/_rodded_material_8_c.html @@ -130,7 +130,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8h.html b/doxygen/_rodded_material_8h.html index 528ebf395..f2b9a9816 100644 --- a/doxygen/_rodded_material_8h.html +++ b/doxygen/_rodded_material_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_rodded_material_8h_source.html b/doxygen/_rodded_material_8h_source.html index a6377c50c..d38c8dc67 100644 --- a/doxygen/_rodded_material_8h_source.html +++ b/doxygen/_rodded_material_8h_source.html @@ -124,7 +124,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 10c001458..15df2f4e8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1f4fea4f4..40b53fbe3 100644 --- a/doxygen/_s_a_tau_material_8h.html +++ b/doxygen/_s_a_tau_material_8h.html @@ -128,7 +128,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8232d5afd..27c28df5a 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 333ad4075..ad0b258c4 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 935b75f01..a54ed20ee 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 43667f214..cf56b71f9 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 9bfc1f0be..f51f0b052 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 89e0f7ba3..8b3237570 100644 --- a/doxygen/_s_a_time_derivative_8h.html +++ b/doxygen/_s_a_time_derivative_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 39cd10f30..92848fa67 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 dbc4efbbd..8830c1a19 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a35b2169f..82b94ef13 100644 --- a/doxygen/_s_a_turbulent_viscosity_8h.html +++ b/doxygen/_s_a_turbulent_viscosity_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8dfbac5db..756b5eff3 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 5920b53ad..6c1dd1f98 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8f3296639..51c85508d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8b11b8bf2..cac49bf69 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a03944680..925704e00 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b5b723f12..f9adfd498 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7d56fe834..ba4e57511 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f4b340fac..9096e6c44 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7af7dc34a..e7603d5cd 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1814d6188..dba418929 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 77cddb94f..018a0f1fc 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 918b848b2..334048a1b 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7c851be35..99e6aed83 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c43ee1bae..58e2fe353 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c9880b5c1..9afe06285 100644 --- a/doxygen/_scalar_advection_art_diff_8h.html +++ b/doxygen/_scalar_advection_art_diff_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 cf558c341..26b971533 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3d6d6d3ba..70fb541f2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 70d9a9eab..4b58c5dd3 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6a1ed8360..05997f349 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 55c016a19..c08797503 100644 --- a/doxygen/_scalar_transport_base_8_c.html +++ b/doxygen/_scalar_transport_base_8_c.html @@ -93,7 +93,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_scalar_transport_base_8h.html b/doxygen/_scalar_transport_base_8h.html index 5d45ec342..939078c1d 100644 --- a/doxygen/_scalar_transport_base_8h.html +++ b/doxygen/_scalar_transport_base_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c946278c9..48e3bc4ae 100644 --- a/doxygen/_scalar_transport_base_8h_source.html +++ b/doxygen/_scalar_transport_base_8h_source.html @@ -145,7 +145,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 88b1ac687..d6904011d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 9664297f0..985c85ff5 100644 --- a/doxygen/_scalar_transport_time_derivative_8h.html +++ b/doxygen/_scalar_transport_time_derivative_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0a2b211af..fb7c6f03e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6cd85580c..54d13ccf1 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f1283e823..066ec19a8 100644 --- a/doxygen/_side_weighted_integral_postprocessor_8h.html +++ b/doxygen/_side_weighted_integral_postprocessor_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1c9493082..d10622b3a 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8_c.html b/doxygen/_sigma_r_8_c.html index d02f800e6..5deeb4099 100644 --- a/doxygen/_sigma_r_8_c.html +++ b/doxygen/_sigma_r_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8h.html b/doxygen/_sigma_r_8h.html index 0a19be1bf..39f8957e5 100644 --- a/doxygen/_sigma_r_8h.html +++ b/doxygen/_sigma_r_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_sigma_r_8h_source.html b/doxygen/_sigma_r_8h_source.html index 6f4923d27..ba1d4a96f 100644 --- a/doxygen/_sigma_r_8h_source.html +++ b/doxygen/_sigma_r_8h_source.html @@ -126,7 +126,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e0035b7cf..847a2cd81 100644 --- a/doxygen/_total_neutron_leakage_8_c.html +++ b/doxygen/_total_neutron_leakage_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_total_neutron_leakage_8h.html b/doxygen/_total_neutron_leakage_8h.html index 65ad1be6d..a772314c2 100644 --- a/doxygen/_total_neutron_leakage_8h.html +++ b/doxygen/_total_neutron_leakage_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 39c239651..2655c8106 100644 --- a/doxygen/_total_neutron_leakage_8h_source.html +++ b/doxygen/_total_neutron_leakage_8h_source.html @@ -124,7 +124,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 637110293..bc7423693 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 641a5fb11..57d9b1cea 100644 --- a/doxygen/_transient_fission_heat_source_8h.html +++ b/doxygen/_transient_fission_heat_source_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f700ec0bb..1af0c2931 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c7882848b..4cd64b96b 100644 --- a/doxygen/_turbulent_stress_aux_8_c.html +++ b/doxygen/_turbulent_stress_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_turbulent_stress_aux_8h.html b/doxygen/_turbulent_stress_aux_8h.html index 24f0118aa..80f3f71f8 100644 --- a/doxygen/_turbulent_stress_aux_8h.html +++ b/doxygen/_turbulent_stress_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 69e3361b3..b2e065787 100644 --- a/doxygen/_turbulent_stress_aux_8h_source.html +++ b/doxygen/_turbulent_stress_aux_8h_source.html @@ -119,7 +119,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e06b4374a..0bf563374 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 251c24bb1..dab8b73b3 100644 --- a/doxygen/_vacuum_conc_b_c_8h.html +++ b/doxygen/_vacuum_conc_b_c_8h.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1091cc5a4..7cd5ace01 100644 --- a/doxygen/_vacuum_conc_b_c_8h_source.html +++ b/doxygen/_vacuum_conc_b_c_8h_source.html @@ -138,7 +138,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 dfa376895..8784f660f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a0d18521e..f3c89f599 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f71e797bb..adccacbd7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c9b4e2e59..dda14e87b 100644 --- a/doxygen/_wall_distance_aux_8_c.html +++ b/doxygen/_wall_distance_aux_8_c.html @@ -129,7 +129,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/_wall_distance_aux_8h.html b/doxygen/_wall_distance_aux_8h.html index 56860de38..3bedf54c2 100644 --- a/doxygen/_wall_distance_aux_8h.html +++ b/doxygen/_wall_distance_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 91e0af463..2c513a09a 100644 --- a/doxygen/_wall_distance_aux_8h_source.html +++ b/doxygen/_wall_distance_aux_8h_source.html @@ -116,7 +116,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a03bc4e71..9125d68cd 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 41b87fcc9..0d6d95f54 100644 --- a/doxygen/_wall_shear_stress_aux_8h.html +++ b/doxygen/_wall_shear_stress_aux_8h.html @@ -107,7 +107,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 49b64c43c..8287e97a8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/annotated.html b/doxygen/annotated.html index 4cc9f735c..7be985e9d 100644 --- a/doxygen/annotated.html +++ b/doxygen/annotated.html @@ -164,7 +164,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 38955d95f..0126493f7 100644 --- a/doxygen/class_average_fission_heat-members.html +++ b/doxygen/class_average_fission_heat-members.html @@ -110,7 +110,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_average_fission_heat.html b/doxygen/class_average_fission_heat.html index 9761b15cf..e179d95b1 100644 --- a/doxygen/class_average_fission_heat.html +++ b/doxygen/class_average_fission_heat.html @@ -378,7 +378,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_fuel-members.html b/doxygen/class_cammi_fuel-members.html index 0e8cf7526..3e094d501 100644 --- a/doxygen/class_cammi_fuel-members.html +++ b/doxygen/class_cammi_fuel-members.html @@ -170,7 +170,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_fuel.html b/doxygen/class_cammi_fuel.html index 6cb11b5cc..222f40208 100644 --- a/doxygen/class_cammi_fuel.html +++ b/doxygen/class_cammi_fuel.html @@ -412,7 +412,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_moderator-members.html b/doxygen/class_cammi_moderator-members.html index 9aa236eab..93f858c38 100644 --- a/doxygen/class_cammi_moderator-members.html +++ b/doxygen/class_cammi_moderator-members.html @@ -169,7 +169,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_cammi_moderator.html b/doxygen/class_cammi_moderator.html index dda454843..48c9229b2 100644 --- a/doxygen/class_cammi_moderator.html +++ b/doxygen/class_cammi_moderator.html @@ -388,7 +388,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ab0da504f..199e912c7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 2c53c8dfa..b808ec418 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1b06b06c0..1cb7e12c6 100644 --- a/doxygen/class_constant_difference_aux-members.html +++ b/doxygen/class_constant_difference_aux-members.html @@ -90,7 +90,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_constant_difference_aux.html b/doxygen/class_constant_difference_aux.html index 5f06cda7e..5e5125bad 100644 --- a/doxygen/class_constant_difference_aux.html +++ b/doxygen/class_constant_difference_aux.html @@ -239,7 +239,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d6ba12456..77ed0a5e0 100644 --- a/doxygen/class_convective_heat_exchanger-members.html +++ b/doxygen/class_convective_heat_exchanger-members.html @@ -91,7 +91,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_convective_heat_exchanger.html b/doxygen/class_convective_heat_exchanger.html index 9c0c3d9af..47757cb10 100644 --- a/doxygen/class_convective_heat_exchanger.html +++ b/doxygen/class_convective_heat_exchanger.html @@ -264,7 +264,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 df39dd071..68c7eb2a7 100644 --- a/doxygen/class_coupled_fission_kernel-members.html +++ b/doxygen/class_coupled_fission_kernel-members.html @@ -113,7 +113,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_fission_kernel.html b/doxygen/class_coupled_fission_kernel.html index 5b0767b80..f4d6287ae 100644 --- a/doxygen/class_coupled_fission_kernel.html +++ b/doxygen/class_coupled_fission_kernel.html @@ -654,7 +654,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 06dcfc29c..10bf5ac91 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 713ce6db5..3a5542a43 100644 --- a/doxygen/class_coupled_outflow_b_c.html +++ b/doxygen/class_coupled_outflow_b_c.html @@ -213,7 +213,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7b487b664..73a0088a8 100644 --- a/doxygen/class_coupled_scalar_advection-members.html +++ b/doxygen/class_coupled_scalar_advection-members.html @@ -108,7 +108,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_coupled_scalar_advection.html b/doxygen/class_coupled_scalar_advection.html index 3eade017a..ca2b05c48 100644 --- a/doxygen/class_coupled_scalar_advection.html +++ b/doxygen/class_coupled_scalar_advection.html @@ -537,7 +537,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1925faa30..e7766497c 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 089524852..0eafa3a3d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 467aeacf7..dc5e1f31f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ae31ffe1f..c8cd0bc7b 100644 --- a/doxygen/class_d_g_turbulent_diffusion.html +++ b/doxygen/class_d_g_turbulent_diffusion.html @@ -498,7 +498,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8821fcca3..1f3b13c62 100644 --- a/doxygen/class_decay_heat_source-members.html +++ b/doxygen/class_decay_heat_source-members.html @@ -101,7 +101,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_decay_heat_source.html b/doxygen/class_decay_heat_source.html index 32ff9c2a0..33d9bf686 100644 --- a/doxygen/class_decay_heat_source.html +++ b/doxygen/class_decay_heat_source.html @@ -364,7 +364,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6813e39db..6a80dc140 100644 --- a/doxygen/class_delayed_neutron_source-members.html +++ b/doxygen/class_delayed_neutron_source-members.html @@ -106,7 +106,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_delayed_neutron_source.html b/doxygen/class_delayed_neutron_source.html index 654d04e58..306f55ea6 100644 --- a/doxygen/class_delayed_neutron_source.html +++ b/doxygen/class_delayed_neutron_source.html @@ -484,7 +484,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 43477970e..df54aeff3 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7af7c9c68..5ddb1d17e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f4816ba04..60c331fc6 100644 --- a/doxygen/class_dirac_h_x-members.html +++ b/doxygen/class_dirac_h_x-members.html @@ -91,7 +91,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_dirac_h_x.html b/doxygen/class_dirac_h_x.html index d21d825ff..987f6cb90 100644 --- a/doxygen/class_dirac_h_x.html +++ b/doxygen/class_dirac_h_x.html @@ -263,7 +263,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 560532ab6..00e9bd0cd 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d435f323e..e5e8bf2e3 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_division_postprocessor-members.html b/doxygen/class_division_postprocessor-members.html index 1ad3abfd7..c89efc4ad 100644 --- a/doxygen/class_division_postprocessor-members.html +++ b/doxygen/class_division_postprocessor-members.html @@ -88,7 +88,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_division_postprocessor.html b/doxygen/class_division_postprocessor.html index ef982f3f2..ded4edc22 100644 --- a/doxygen/class_division_postprocessor.html +++ b/doxygen/class_division_postprocessor.html @@ -183,7 +183,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ea6041b32..0b9b9bf18 100644 --- a/doxygen/class_element_l2_diff-members.html +++ b/doxygen/class_element_l2_diff-members.html @@ -90,7 +90,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_element_l2_diff.html b/doxygen/class_element_l2_diff.html index f1c667856..c5272521f 100644 --- a/doxygen/class_element_l2_diff.html +++ b/doxygen/class_element_l2_diff.html @@ -240,7 +240,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 712752117..99a3ec930 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ed4c7328d..2351e669d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ec10cf843..af9da0b8d 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 471cdc1f9..bf0687166 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 bbef66e66..cca823253 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 20e0a1384..363ed72d4 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6ccc7b68b..929f273ea 100644 --- a/doxygen/class_fission_heat_source-members.html +++ b/doxygen/class_fission_heat_source-members.html @@ -99,7 +99,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_fission_heat_source.html b/doxygen/class_fission_heat_source.html index ebecd619a..7c603f9b6 100644 --- a/doxygen/class_fission_heat_source.html +++ b/doxygen/class_fission_heat_source.html @@ -462,7 +462,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e2109e8c1..7e3539e34 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 765c5797d..e65da61e8 100644 --- a/doxygen/class_fission_heat_source_aux.html +++ b/doxygen/class_fission_heat_source_aux.html @@ -364,7 +364,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c49cc736d..496bbf820 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e99d3b4b4..7c92c4d99 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 45df70853..9ad9fb7e6 100644 --- a/doxygen/class_gamma_heat_source-members.html +++ b/doxygen/class_gamma_heat_source-members.html @@ -91,7 +91,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_gamma_heat_source.html b/doxygen/class_gamma_heat_source.html index d1b89cc3c..1c99ec5d1 100644 --- a/doxygen/class_gamma_heat_source.html +++ b/doxygen/class_gamma_heat_source.html @@ -264,7 +264,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7bbc62d5f..6d8106b40 100644 --- a/doxygen/class_generic_moltres_material-members.html +++ b/doxygen/class_generic_moltres_material-members.html @@ -167,7 +167,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_generic_moltres_material.html b/doxygen/class_generic_moltres_material.html index 724ca389a..2e81c9c4a 100644 --- a/doxygen/class_generic_moltres_material.html +++ b/doxygen/class_generic_moltres_material.html @@ -698,7 +698,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7c965de47..57c1983ef 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 48c962059..15067cdfa 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_group_diffusion-members.html b/doxygen/class_group_diffusion-members.html index 24eb51439..f24612ecc 100644 --- a/doxygen/class_group_diffusion-members.html +++ b/doxygen/class_group_diffusion-members.html @@ -101,7 +101,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_group_diffusion.html b/doxygen/class_group_diffusion.html index e78d6a41c..d2740808c 100644 --- a/doxygen/class_group_diffusion.html +++ b/doxygen/class_group_diffusion.html @@ -364,7 +364,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 fb633698b..e5c1a6265 100644 --- a/doxygen/class_heat_precursor_decay-members.html +++ b/doxygen/class_heat_precursor_decay-members.html @@ -98,7 +98,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_decay.html b/doxygen/class_heat_precursor_decay.html index d63de39a7..fd2ac3a22 100644 --- a/doxygen/class_heat_precursor_decay.html +++ b/doxygen/class_heat_precursor_decay.html @@ -290,7 +290,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 57170da80..c33e7e5f1 100644 --- a/doxygen/class_heat_precursor_source-members.html +++ b/doxygen/class_heat_precursor_source-members.html @@ -110,7 +110,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_heat_precursor_source.html b/doxygen/class_heat_precursor_source.html index b6e9c298c..ab92549a4 100644 --- a/doxygen/class_heat_precursor_source.html +++ b/doxygen/class_heat_precursor_source.html @@ -582,7 +582,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ffc551896..22ccdcbc7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a480ef9a3..0b607a7f1 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 da1ddd6df..7f2ba3054 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 9173f6800..e244021b5 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 abf9aa372..a3ba4a672 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f4bdf517a..8bc8fb05b 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 92b63e028..ba08e2cbc 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f3871d39b..18d8e40e8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 34c638b0b..ffd74030b 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 4ace05b3b..3dbfe66fd 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b93e4be0b..0b8d048d5 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 5ab5c832f..5da17fd90 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_in_scatter-members.html b/doxygen/class_in_scatter-members.html index c5665b0f3..d86cd2483 100644 --- a/doxygen/class_in_scatter-members.html +++ b/doxygen/class_in_scatter-members.html @@ -105,7 +105,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_in_scatter.html b/doxygen/class_in_scatter.html index 4ec52d0fe..c5c5e2c28 100644 --- a/doxygen/class_in_scatter.html +++ b/doxygen/class_in_scatter.html @@ -460,7 +460,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 461927047..0820c4587 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ef9b68f5f..0b677d7ba 100644 --- a/doxygen/class_integral_new_variable_postprocessor.html +++ b/doxygen/class_integral_new_variable_postprocessor.html @@ -297,7 +297,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3cc6afb0c..8d4521394 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 009fafee1..a1ff5e4cb 100644 --- a/doxygen/class_integral_old_variable_postprocessor.html +++ b/doxygen/class_integral_old_variable_postprocessor.html @@ -270,7 +270,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_limit_k-members.html b/doxygen/class_limit_k-members.html index 979c1d222..0dd427009 100644 --- a/doxygen/class_limit_k-members.html +++ b/doxygen/class_limit_k-members.html @@ -94,7 +94,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_limit_k.html b/doxygen/class_limit_k.html index 3917ebb64..1835879a7 100644 --- a/doxygen/class_limit_k.html +++ b/doxygen/class_limit_k.html @@ -335,7 +335,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b21efcdba..5666b8c77 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e3c38c8cd..db74f6ecb 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 564be7ae2..d54d7ce74 100644 --- a/doxygen/class_mat_diffusion_aux-members.html +++ b/doxygen/class_mat_diffusion_aux-members.html @@ -91,7 +91,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_mat_diffusion_aux.html b/doxygen/class_mat_diffusion_aux.html index 47634e38b..57b123c10 100644 --- a/doxygen/class_mat_diffusion_aux.html +++ b/doxygen/class_mat_diffusion_aux.html @@ -268,7 +268,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ee0d78d1c..e666d20d9 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 687151ee2..d9a164b9f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 03d6133dd..0654e460f 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 32f82663f..4a4b0f0f7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_app-members.html b/doxygen/class_moltres_app-members.html index 16feb030e..e28a025b9 100644 --- a/doxygen/class_moltres_app-members.html +++ b/doxygen/class_moltres_app-members.html @@ -90,7 +90,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_app.html b/doxygen/class_moltres_app.html index b4aaf53f3..130cd2240 100644 --- a/doxygen/class_moltres_app.html +++ b/doxygen/class_moltres_app.html @@ -251,7 +251,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 18edf6344..51ac7f6e4 100644 --- a/doxygen/class_moltres_json_material-members.html +++ b/doxygen/class_moltres_json_material-members.html @@ -156,7 +156,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_moltres_json_material.html b/doxygen/class_moltres_json_material.html index c0f3ede9d..12d85679d 100644 --- a/doxygen/class_moltres_json_material.html +++ b/doxygen/class_moltres_json_material.html @@ -402,7 +402,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 aae6d996c..6b4fd59db 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 1d023c1fe..e15a970f7 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_neutron_leakage-members.html b/doxygen/class_neutron_leakage-members.html index a5efb5a5f..3b52de4ed 100644 --- a/doxygen/class_neutron_leakage-members.html +++ b/doxygen/class_neutron_leakage-members.html @@ -90,7 +90,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_neutron_leakage.html b/doxygen/class_neutron_leakage.html index 2e44c711f..edfc5e1a7 100644 --- a/doxygen/class_neutron_leakage.html +++ b/doxygen/class_neutron_leakage.html @@ -239,7 +239,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_action-members.html b/doxygen/class_nt_action-members.html index 7f4c82066..9c86aa16e 100644 --- a/doxygen/class_nt_action-members.html +++ b/doxygen/class_nt_action-members.html @@ -97,7 +97,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_action.html b/doxygen/class_nt_action.html index 05489714f..81e6778f5 100644 --- a/doxygen/class_nt_action.html +++ b/doxygen/class_nt_action.html @@ -452,7 +452,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 fe7b51baa..4beeca01a 100644 --- a/doxygen/class_nt_time_derivative-members.html +++ b/doxygen/class_nt_time_derivative-members.html @@ -104,7 +104,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nt_time_derivative.html b/doxygen/class_nt_time_derivative.html index acc72f6e9..6162d0d14 100644 --- a/doxygen/class_nt_time_derivative.html +++ b/doxygen/class_nt_time_derivative.html @@ -379,7 +379,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nuclear_material-members.html b/doxygen/class_nuclear_material-members.html index 4903efb50..c9fdc067b 100644 --- a/doxygen/class_nuclear_material-members.html +++ b/doxygen/class_nuclear_material-members.html @@ -151,7 +151,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nuclear_material.html b/doxygen/class_nuclear_material.html index 12ab877ed..0c7ffcf71 100644 --- a/doxygen/class_nuclear_material.html +++ b/doxygen/class_nuclear_material.html @@ -1602,7 +1602,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nusselt-members.html b/doxygen/class_nusselt-members.html index c60deb2be..7c8660846 100644 --- a/doxygen/class_nusselt-members.html +++ b/doxygen/class_nusselt-members.html @@ -92,7 +92,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_nusselt.html b/doxygen/class_nusselt.html index 7b2736dfd..34e865f1d 100644 --- a/doxygen/class_nusselt.html +++ b/doxygen/class_nusselt.html @@ -285,7 +285,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 770c90c75..9926ec994 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e6a4baf2a..bc743fd2c 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_action-members.html b/doxygen/class_precursor_action-members.html index eddf1c8bf..bf29b6c13 100644 --- a/doxygen/class_precursor_action-members.html +++ b/doxygen/class_precursor_action-members.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_action.html b/doxygen/class_precursor_action.html index cff1d0132..f9f399c0c 100644 --- a/doxygen/class_precursor_action.html +++ b/doxygen/class_precursor_action.html @@ -814,7 +814,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_decay-members.html b/doxygen/class_precursor_decay-members.html index 929c6d269..d9201b4d8 100644 --- a/doxygen/class_precursor_decay-members.html +++ b/doxygen/class_precursor_decay-members.html @@ -103,7 +103,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_decay.html b/doxygen/class_precursor_decay.html index f7df1ed37..d0e44c00d 100644 --- a/doxygen/class_precursor_decay.html +++ b/doxygen/class_precursor_decay.html @@ -412,7 +412,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_source-members.html b/doxygen/class_precursor_source-members.html index 9c8801dea..1f1bfff4e 100644 --- a/doxygen/class_precursor_source-members.html +++ b/doxygen/class_precursor_source-members.html @@ -109,7 +109,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_precursor_source.html b/doxygen/class_precursor_source.html index a3519ccf1..4d9262903 100644 --- a/doxygen/class_precursor_source.html +++ b/doxygen/class_precursor_source.html @@ -556,7 +556,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_rodded_material-members.html b/doxygen/class_rodded_material-members.html index 38080dce0..8a567e573 100644 --- a/doxygen/class_rodded_material-members.html +++ b/doxygen/class_rodded_material-members.html @@ -173,7 +173,7 @@
-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_rodded_material.html b/doxygen/class_rodded_material.html index 554ce4413..a8f98fe16 100644 --- a/doxygen/class_rodded_material.html +++ b/doxygen/class_rodded_material.html @@ -505,7 +505,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 323342588..6c4fc7b3a 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f27880388..d26a2090c 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 d7bde7e0c..992e85b28 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b2689ddff..4f8d61a03 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 a3d43948a..87f0d1619 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 8fda6023b..86229295a 100644 --- a/doxygen/class_s_a_time_derivative.html +++ b/doxygen/class_s_a_time_derivative.html @@ -215,7 +215,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0dea162b0..a4dec9634 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 65dc81da5..1bbe29c28 100644 --- a/doxygen/class_s_a_turbulent_viscosity.html +++ b/doxygen/class_s_a_turbulent_viscosity.html @@ -311,7 +311,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 5107a642b..37962a953 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ca7fe839d..9357f81e2 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ec661b237..007ef33d8 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 86c63c68f..e958602ac 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 eec991fff..d6733b669 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 3de3dc0b8..27a22797e 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 b7683188a..59f758159 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0d678ca4e..f246fc306 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 Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 136a65dd9..2b4da4458 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6d0829bae..5e0bd441e 100644 --- a/doxygen/class_scalar_advection_art_diff.html +++ b/doxygen/class_scalar_advection_art_diff.html @@ -652,7 +652,7 @@

-Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 f85f45676..b204436e1 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 6d2abe0f6..6be46601b 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ee98c5ecb..e8ba2c596 100644 --- a/doxygen/class_scalar_transport_base-members.html +++ b/doxygen/class_scalar_transport_base-members.html @@ -93,7 +93,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_scalar_transport_base.html b/doxygen/class_scalar_transport_base.html index 465f00084..f44cfdb7e 100644 --- a/doxygen/class_scalar_transport_base.html +++ b/doxygen/class_scalar_transport_base.html @@ -473,7 +473,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 aacef47ee..e9b5fd617 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 90aab64d5..f110f9c4b 100644 --- a/doxygen/class_scalar_transport_time_derivative.html +++ b/doxygen/class_scalar_transport_time_derivative.html @@ -292,7 +292,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 39720585f..b344c4a05 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 993a732c3..692fddc6b 100644 --- a/doxygen/class_side_weighted_integral_postprocessor.html +++ b/doxygen/class_side_weighted_integral_postprocessor.html @@ -215,7 +215,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_sigma_r-members.html b/doxygen/class_sigma_r-members.html index f2c7eb169..bf66fabdb 100644 --- a/doxygen/class_sigma_r-members.html +++ b/doxygen/class_sigma_r-members.html @@ -101,7 +101,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_sigma_r.html b/doxygen/class_sigma_r.html index 292e63587..bc638b098 100644 --- a/doxygen/class_sigma_r.html +++ b/doxygen/class_sigma_r.html @@ -364,7 +364,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 c049e9c62..4395e4468 100644 --- a/doxygen/class_total_neutron_leakage-members.html +++ b/doxygen/class_total_neutron_leakage-members.html @@ -100,7 +100,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_total_neutron_leakage.html b/doxygen/class_total_neutron_leakage.html index 7fe77dd4a..d0ba50a49 100644 --- a/doxygen/class_total_neutron_leakage.html +++ b/doxygen/class_total_neutron_leakage.html @@ -335,7 +335,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 ba5986ce6..7157b63a2 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 9b2c2d5dc..6372b4457 100644 --- a/doxygen/class_transient_fission_heat_source.html +++ b/doxygen/class_transient_fission_heat_source.html @@ -606,7 +606,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 e4d3dbb26..1680cb345 100644 --- a/doxygen/class_turbulent_stress_aux-members.html +++ b/doxygen/class_turbulent_stress_aux-members.html @@ -92,7 +92,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_turbulent_stress_aux.html b/doxygen/class_turbulent_stress_aux.html index 29081d490..c1a7c7a9a 100644 --- a/doxygen/class_turbulent_stress_aux.html +++ b/doxygen/class_turbulent_stress_aux.html @@ -287,7 +287,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7404700f2..731e430f9 100644 --- a/doxygen/class_vacuum_conc_b_c-members.html +++ b/doxygen/class_vacuum_conc_b_c-members.html @@ -102,7 +102,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 79ac2769f..cdec72ddd 100644 --- a/doxygen/class_vacuum_conc_b_c.html +++ b/doxygen/class_vacuum_conc_b_c.html @@ -329,7 +329,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 444cce315..fbc279825 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 0c2ac5db4..2d2c96ea5 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 bf24fe160..7446e96cb 100644 --- a/doxygen/class_wall_distance_aux-members.html +++ b/doxygen/class_wall_distance_aux-members.html @@ -89,7 +89,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/class_wall_distance_aux.html b/doxygen/class_wall_distance_aux.html index 7dd78f2bb..0a955572a 100644 --- a/doxygen/class_wall_distance_aux.html +++ b/doxygen/class_wall_distance_aux.html @@ -213,7 +213,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 7063977b8..39b99ef8c 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 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 18b61cae4..610161e40 100644 --- a/doxygen/class_wall_shear_stress_aux.html +++ b/doxygen/class_wall_shear_stress_aux.html @@ -263,7 +263,7 @@

-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/classes.html b/doxygen/classes.html index 294949bad..36a9d6501 100644 --- a/doxygen/classes.html +++ b/doxygen/classes.html @@ -136,7 +136,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000001_000012.html b/doxygen/dir_000001_000012.html index 82b241bad..7b1a5d47c 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000003_000012.html b/doxygen/dir_000003_000012.html index 94d548695..831f02ecb 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000005_000012.html b/doxygen/dir_000005_000012.html index 5efcf3878..f7eb03a59 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000006_000004.html b/doxygen/dir_000006_000004.html index fbaa50723..2eb5d1ec2 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000007_000012.html b/doxygen/dir_000007_000012.html index 203c98eb0..223b082d7 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000009_000012.html b/doxygen/dir_000009_000012.html index a83b69497..f255b4364 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000011_000012.html b/doxygen/dir_000011_000012.html index 7f68ff695..584fb8824 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000013_000004.html b/doxygen/dir_000013_000004.html index bd8303251..3b7ffe041 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000014_000012.html b/doxygen/dir_000014_000012.html index 05852924b..5f3fd04d5 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000016_000012.html b/doxygen/dir_000016_000012.html index 227f4fad2..ea82f1169 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000017_000004.html b/doxygen/dir_000017_000004.html index 2c8bb5374..08f1cdd30 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000018_000012.html b/doxygen/dir_000018_000012.html index 8380a58bf..3bbcf6bb8 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_000019_000012.html b/doxygen/dir_000019_000012.html index a72d5b39b..7772a262c 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 Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html b/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html index 17fdc3059..b3b963ab2 100644 --- a/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html +++ b/doxygen/dir_0af1587c8378955de40f48b4bd1869f0.html @@ -99,7 +99,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html b/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html index c41513843..18596fd8e 100644 --- a/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html +++ b/doxygen/dir_0b9ed7732631b4e65a5030233eb5fc5a.html @@ -101,7 +101,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html b/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html index 0e5fd51ae..260be8ed3 100644 --- a/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html +++ b/doxygen/dir_40856f0cdd4bcafd28810d9265a200f7.html @@ -145,7 +145,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html b/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html index 04f934d58..0658bfc12 100644 --- a/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html +++ b/doxygen/dir_52afe6394927cedcb1ddeb1178eb9949.html @@ -113,7 +113,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html b/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html index 869ed2a63..b9c04d276 100644 --- a/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html +++ b/doxygen/dir_5cafbbc4d3ca7520a589c9bb006faf2e.html @@ -97,7 +97,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 701e7566d..6b8a82c9e 100644 --- a/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/doxygen/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -118,7 +118,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html b/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html index 4be5902b2..310831282 100644 --- a/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html +++ b/doxygen/dir_6c5a344b9c03c6428d49f0b38500fe7f.html @@ -123,7 +123,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html b/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html index e32bdd5fb..a0c57c817 100644 --- a/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html +++ b/doxygen/dir_6c6f4828ced252df7a457d18180150c1.html @@ -97,7 +97,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html b/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html index 2ac643fa2..2fa3f8148 100644 --- a/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html +++ b/doxygen/dir_79fa9b12a48436e6d1fb80a586e19af1.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html b/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html index 43bfe8780..8c6e58f66 100644 --- a/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html +++ b/doxygen/dir_88ecfc89524da6b1e182c4fbbebb4797.html @@ -119,7 +119,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html b/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html index 398268b3b..8f98a9870 100644 --- a/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html +++ b/doxygen/dir_a0ffb46312fd942a3bdda3379138cd3d.html @@ -97,7 +97,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html b/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html index 4313cee2c..489820bb6 100644 --- a/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html +++ b/doxygen/dir_ab1c81409f0df724f17c9ef30afee877.html @@ -99,7 +99,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html b/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html index d42bfc1f4..bae668cfc 100644 --- a/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html +++ b/doxygen/dir_ad471e77ba5a72af0767bcb44d2be997.html @@ -113,7 +113,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html b/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html index 752fdf891..6b649f83a 100644 --- a/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html +++ b/doxygen/dir_b42fa4734c76de29a4b97f55d0ce97b5.html @@ -123,7 +123,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html b/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html index 78d832c2d..82f6e4697 100644 --- a/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html +++ b/doxygen/dir_b843596cc84dd0b637fa3210ef36d913.html @@ -119,7 +119,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html b/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html index 20976d954..ebfd80c59 100644 --- a/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html +++ b/doxygen/dir_d2b8d8eda696fb67dda800ae051affdc.html @@ -101,7 +101,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html b/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html index 1804d1bf2..19cb39b16 100644 --- a/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html @@ -113,7 +113,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_e313ae6235229141100fd0edcf178102.html b/doxygen/dir_e313ae6235229141100fd0edcf178102.html index 5bd3f12d6..773683559 100644 --- a/doxygen/dir_e313ae6235229141100fd0edcf178102.html +++ b/doxygen/dir_e313ae6235229141100fd0edcf178102.html @@ -97,7 +97,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html b/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html index 276023b4a..3582f9891 100644 --- a/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html +++ b/doxygen/dir_e8162cbcd2a0630786d64b00f43c2c71.html @@ -117,7 +117,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html b/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html index c92a62840..a19fda7ac 100644 --- a/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html +++ b/doxygen/dir_f2fd8bd6424c93166d6dd5f2b70706e7.html @@ -145,7 +145,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/files.html b/doxygen/files.html index f27dd080b..26978a863 100644 --- a/doxygen/files.html +++ b/doxygen/files.html @@ -263,7 +263,7 @@
-Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
diff --git a/doxygen/functions.html b/doxygen/functions.html index 4e09a860e..1f3473a4f 100644 --- a/doxygen/functions.html +++ b/doxygen/functions.html @@ -261,7 +261,7 @@

- _ -

    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
    diff --git a/doxygen/functions_a.html b/doxygen/functions_a.html index e6db7f38e..9c79ee516 100644 --- a/doxygen/functions_a.html +++ b/doxygen/functions_a.html @@ -102,7 +102,7 @@

    - a -

      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
      diff --git a/doxygen/functions_b.html b/doxygen/functions_b.html index 9a1324c60..e6eed1884 100644 --- a/doxygen/functions_b.html +++ b/doxygen/functions_b.html @@ -87,7 +87,7 @@

      - b -

        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
        diff --git a/doxygen/functions_c.html b/doxygen/functions_c.html index 54cb40ad4..91c1c7832 100644 --- a/doxygen/functions_c.html +++ b/doxygen/functions_c.html @@ -110,7 +110,7 @@

        - c -

          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
          diff --git a/doxygen/functions_d.html b/doxygen/functions_d.html index 2ff728a66..6f1bd9a85 100644 --- a/doxygen/functions_d.html +++ b/doxygen/functions_d.html @@ -91,7 +91,7 @@

          - d -

            -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
            diff --git a/doxygen/functions_e.html b/doxygen/functions_e.html index d3f202ec9..d0442074d 100644 --- a/doxygen/functions_e.html +++ b/doxygen/functions_e.html @@ -88,7 +88,7 @@

            - e -

              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_enum.html b/doxygen/functions_enum.html index e53acdf48..61b1fb09f 100644 --- a/doxygen/functions_enum.html +++ b/doxygen/functions_enum.html @@ -83,7 +83,7 @@
              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_eval.html b/doxygen/functions_eval.html index e6bf48608..61dce0377 100644 --- a/doxygen/functions_eval.html +++ b/doxygen/functions_eval.html @@ -90,7 +90,7 @@
              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
              diff --git a/doxygen/functions_f.html b/doxygen/functions_f.html index f220968a5..abc70a67c 100644 --- a/doxygen/functions_f.html +++ b/doxygen/functions_f.html @@ -88,7 +88,7 @@

              - f -

                -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                diff --git a/doxygen/functions_func.html b/doxygen/functions_func.html index f665db97b..dbc5589ac 100644 --- a/doxygen/functions_func.html +++ b/doxygen/functions_func.html @@ -102,7 +102,7 @@

                - a -

                  -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                  diff --git a/doxygen/functions_func_b.html b/doxygen/functions_func_b.html index bbfa439d1..af0316910 100644 --- a/doxygen/functions_func_b.html +++ b/doxygen/functions_func_b.html @@ -85,7 +85,7 @@

                  - b -

                    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                    diff --git a/doxygen/functions_func_c.html b/doxygen/functions_func_c.html index 38ec84127..b8567f511 100644 --- a/doxygen/functions_func_c.html +++ b/doxygen/functions_func_c.html @@ -110,7 +110,7 @@

                    - c -

                      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                      diff --git a/doxygen/functions_func_d.html b/doxygen/functions_func_d.html index c75892a4f..f372c7916 100644 --- a/doxygen/functions_func_d.html +++ b/doxygen/functions_func_d.html @@ -91,7 +91,7 @@

                      - d -

                        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                        diff --git a/doxygen/functions_func_e.html b/doxygen/functions_func_e.html index 1d317a416..967fa77ed 100644 --- a/doxygen/functions_func_e.html +++ b/doxygen/functions_func_e.html @@ -88,7 +88,7 @@

                        - e -

                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                          diff --git a/doxygen/functions_func_f.html b/doxygen/functions_func_f.html index 552fd8818..0ba985248 100644 --- a/doxygen/functions_func_f.html +++ b/doxygen/functions_func_f.html @@ -88,7 +88,7 @@

                          - f -

                            -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                            diff --git a/doxygen/functions_func_g.html b/doxygen/functions_func_g.html index ec6ba028c..a046fd520 100644 --- a/doxygen/functions_func_g.html +++ b/doxygen/functions_func_g.html @@ -89,7 +89,7 @@

                            - g -

                              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                              diff --git a/doxygen/functions_func_h.html b/doxygen/functions_func_h.html index f477f7edb..0f583f5b1 100644 --- a/doxygen/functions_func_h.html +++ b/doxygen/functions_func_h.html @@ -85,7 +85,7 @@

                              - h -

                                -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                diff --git a/doxygen/functions_func_i.html b/doxygen/functions_func_i.html index 8dc0ad4e0..b68d032db 100644 --- a/doxygen/functions_func_i.html +++ b/doxygen/functions_func_i.html @@ -94,7 +94,7 @@

                                - i -

                                  -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                  diff --git a/doxygen/functions_func_l.html b/doxygen/functions_func_l.html index dab81ab3d..06fc84c9c 100644 --- a/doxygen/functions_func_l.html +++ b/doxygen/functions_func_l.html @@ -88,7 +88,7 @@

                                  - l -

                                    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                    diff --git a/doxygen/functions_func_m.html b/doxygen/functions_func_m.html index 7978d3be4..87b6f0241 100644 --- a/doxygen/functions_func_m.html +++ b/doxygen/functions_func_m.html @@ -91,7 +91,7 @@

                                    - m -

                                      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                      diff --git a/doxygen/functions_func_n.html b/doxygen/functions_func_n.html index 7b09e068a..4639b7051 100644 --- a/doxygen/functions_func_n.html +++ b/doxygen/functions_func_n.html @@ -88,7 +88,7 @@

                                      - n -

                                        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                        diff --git a/doxygen/functions_func_p.html b/doxygen/functions_func_p.html index d5bf1e9f8..989010bcc 100644 --- a/doxygen/functions_func_p.html +++ b/doxygen/functions_func_p.html @@ -90,7 +90,7 @@

                                        - p -

                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                          diff --git a/doxygen/functions_func_q.html b/doxygen/functions_func_q.html index 2090cce34..7e458a8f0 100644 --- a/doxygen/functions_func_q.html +++ b/doxygen/functions_func_q.html @@ -85,7 +85,7 @@

                                          - q -

                                            -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                            diff --git a/doxygen/functions_func_r.html b/doxygen/functions_func_r.html index e6bff5f82..2b64475cc 100644 --- a/doxygen/functions_func_r.html +++ b/doxygen/functions_func_r.html @@ -86,7 +86,7 @@

                                            - r -

                                              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                              diff --git a/doxygen/functions_func_s.html b/doxygen/functions_func_s.html index cd5f197d2..df90663e1 100644 --- a/doxygen/functions_func_s.html +++ b/doxygen/functions_func_s.html @@ -101,7 +101,7 @@

                                              - s -

                                                -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                diff --git a/doxygen/functions_func_t.html b/doxygen/functions_func_t.html index 04d8300ea..25024b9e0 100644 --- a/doxygen/functions_func_t.html +++ b/doxygen/functions_func_t.html @@ -88,7 +88,7 @@

                                                - t -

                                                  -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                  diff --git a/doxygen/functions_func_v.html b/doxygen/functions_func_v.html index cfd46bf45..622191d6c 100644 --- a/doxygen/functions_func_v.html +++ b/doxygen/functions_func_v.html @@ -86,7 +86,7 @@

                                                  - v -

                                                    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                    diff --git a/doxygen/functions_func_w.html b/doxygen/functions_func_w.html index 73dad6d2a..dc2d3dbe1 100644 --- a/doxygen/functions_func_w.html +++ b/doxygen/functions_func_w.html @@ -85,7 +85,7 @@

                                                    - w -

                                                      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                      diff --git a/doxygen/functions_func_~.html b/doxygen/functions_func_~.html index 6c7d713f1..ed3842ff7 100644 --- a/doxygen/functions_func_~.html +++ b/doxygen/functions_func_~.html @@ -90,7 +90,7 @@

                                                      - ~ -

                                                        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                        diff --git a/doxygen/functions_g.html b/doxygen/functions_g.html index b2f1ff198..2aff7a3fb 100644 --- a/doxygen/functions_g.html +++ b/doxygen/functions_g.html @@ -89,7 +89,7 @@

                                                        - g -

                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                          diff --git a/doxygen/functions_h.html b/doxygen/functions_h.html index 0262a97c2..dcdfef2b5 100644 --- a/doxygen/functions_h.html +++ b/doxygen/functions_h.html @@ -85,7 +85,7 @@

                                                          - h -

                                                            -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                            diff --git a/doxygen/functions_i.html b/doxygen/functions_i.html index de90a0905..613bad5a0 100644 --- a/doxygen/functions_i.html +++ b/doxygen/functions_i.html @@ -95,7 +95,7 @@

                                                            - i -

                                                              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                              diff --git a/doxygen/functions_l.html b/doxygen/functions_l.html index 481a27926..ffb099e18 100644 --- a/doxygen/functions_l.html +++ b/doxygen/functions_l.html @@ -90,7 +90,7 @@

                                                              - l -

                                                                -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                diff --git a/doxygen/functions_m.html b/doxygen/functions_m.html index f2fb5cc3c..3c9170ad8 100644 --- a/doxygen/functions_m.html +++ b/doxygen/functions_m.html @@ -95,7 +95,7 @@

                                                                - m -

                                                                  -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                  diff --git a/doxygen/functions_n.html b/doxygen/functions_n.html index 95c810d66..f6050ffe5 100644 --- a/doxygen/functions_n.html +++ b/doxygen/functions_n.html @@ -89,7 +89,7 @@

                                                                  - n -

                                                                    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                    diff --git a/doxygen/functions_p.html b/doxygen/functions_p.html index 0c841c3fd..fe0fe8adf 100644 --- a/doxygen/functions_p.html +++ b/doxygen/functions_p.html @@ -90,7 +90,7 @@

                                                                    - p -

                                                                      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                      diff --git a/doxygen/functions_q.html b/doxygen/functions_q.html index 6ab01ab7e..c1aa14289 100644 --- a/doxygen/functions_q.html +++ b/doxygen/functions_q.html @@ -85,7 +85,7 @@

                                                                      - q -

                                                                        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                        diff --git a/doxygen/functions_r.html b/doxygen/functions_r.html index 79286af7f..7fbe36e78 100644 --- a/doxygen/functions_r.html +++ b/doxygen/functions_r.html @@ -86,7 +86,7 @@

                                                                        - r -

                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                          diff --git a/doxygen/functions_s.html b/doxygen/functions_s.html index 2cfffc73d..873a3450f 100644 --- a/doxygen/functions_s.html +++ b/doxygen/functions_s.html @@ -102,7 +102,7 @@

                                                                          - s -

                                                                            -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                            diff --git a/doxygen/functions_t.html b/doxygen/functions_t.html index e117fdc63..8517cf659 100644 --- a/doxygen/functions_t.html +++ b/doxygen/functions_t.html @@ -88,7 +88,7 @@

                                                                            - t -

                                                                              -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                              diff --git a/doxygen/functions_v.html b/doxygen/functions_v.html index 5c253f305..8424edd95 100644 --- a/doxygen/functions_v.html +++ b/doxygen/functions_v.html @@ -86,7 +86,7 @@

                                                                              - v -

                                                                                -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                diff --git a/doxygen/functions_vars.html b/doxygen/functions_vars.html index 8d6eb1512..a371d76ad 100644 --- a/doxygen/functions_vars.html +++ b/doxygen/functions_vars.html @@ -261,7 +261,7 @@

                                                                                - _ -

                                                                                  -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                  diff --git a/doxygen/functions_w.html b/doxygen/functions_w.html index 8aa32291d..59de72865 100644 --- a/doxygen/functions_w.html +++ b/doxygen/functions_w.html @@ -85,7 +85,7 @@

                                                                                  - w -

                                                                                    -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                    diff --git a/doxygen/functions_~.html b/doxygen/functions_~.html index 7c914dcee..aa84e6a92 100644 --- a/doxygen/functions_~.html +++ b/doxygen/functions_~.html @@ -90,7 +90,7 @@

                                                                                    - ~ -

                                                                                      -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                      diff --git a/doxygen/globals.html b/doxygen/globals.html index c78e20f20..3542c536a 100644 --- a/doxygen/globals.html +++ b/doxygen/globals.html @@ -98,7 +98,7 @@

                                                                                      - s -

                                                                                        -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                        diff --git a/doxygen/globals_func.html b/doxygen/globals_func.html index 187868c1e..7aa0a16d0 100644 --- a/doxygen/globals_func.html +++ b/doxygen/globals_func.html @@ -93,7 +93,7 @@

                                                                                        - r -

                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/globals_type.html b/doxygen/globals_type.html index 629dd02a7..999c2070c 100644 --- a/doxygen/globals_type.html +++ b/doxygen/globals_type.html @@ -82,7 +82,7 @@
                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/graph_legend.html b/doxygen/graph_legend.html index cb50657f6..d94d2dd49 100644 --- a/doxygen/graph_legend.html +++ b/doxygen/graph_legend.html @@ -142,7 +142,7 @@
                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/hierarchy.html b/doxygen/hierarchy.html index a9541a442..1ac4df84d 100644 --- a/doxygen/hierarchy.html +++ b/doxygen/hierarchy.html @@ -219,7 +219,7 @@
                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/index.html b/doxygen/index.html index 70b98315f..2fd2c1f73 100644 --- a/doxygen/index.html +++ b/doxygen/index.html @@ -82,7 +82,7 @@
                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/inherits.html b/doxygen/inherits.html index 919f4b384..8d4eee227 100644 --- a/doxygen/inherits.html +++ b/doxygen/inherits.html @@ -108,7 +108,7 @@
                                                                                          -Generated on Mon Sep 16 2024 13:01:16 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/doxygen/main_8_c.html b/doxygen/main_8_c.html index 40413116d..b40e66031 100644 --- a/doxygen/main_8_c.html +++ b/doxygen/main_8_c.html @@ -130,7 +130,7 @@

                                                                                          -Generated on Mon Sep 16 2024 13:01:15 for moltres by doxygen 1.9.8 +Generated on Mon Sep 16 2024 17:34:49 for moltres by doxygen 1.9.8
                                                                                          diff --git a/getting_started/eigenvalue.html b/getting_started/eigenvalue.html index aac10d69e..bcba079cb 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 a73b90768..fd9d13f89 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 aa9445a42..2a7f4e4ec 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 81925c004..f3d334b35 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 4054f8a7c..0fbdbf274 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 a9a8b4d8b..5db31cfe3 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 64b8531e1..671024167 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

                                                                                              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. +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 199e1480c..d9a212b0f 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 d0b7cb159..ffca788ee 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 15f85c290..c5d637a38 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 13beb82ad..60b02cd5a 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 5c0f417b2..c531eedf0 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 d7803265e..f7f502e30 100644 --- a/source/actions/NtAction.html +++ b/source/actions/NtAction.html @@ -1,4 +1,4 @@ -NtAction | Moltres

                                                                                                      NtAction

                                                                                                      commentnote

                                                                                                      This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, NOT the variables, kernels, and BCs for precursor tracking. To generate these, see PrecursorAction.

                                                                                                      Overview

                                                                                                      NtAction greatly reduces input file length and complexity by automatically setting up variables, kernels, and BCs for the neutron diffusion equations. When including only the required input parameters, this action constructs the neutron group variables and their associated kernels: SigmaR, GroupDiffusion, InScatter, and CoupledFissionKernel. With account_delayed set to True, DelayedNeutronSource is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions.

                                                                                                      For more information regarding the use of NtAction please refer to the tutorials located here, specifically the Multiphysics Reactor Simulations section.

                                                                                                      Example Input File Syntax

                                                                                                      An example input file without the NtAction, showing only the portion affected by the action:

                                                                                                      [Variables]
+NtAction | Moltres
                                                                                                      NtAction
                                                                                                      commentnote
                                                                                                      This action sets up ONLY the variables, kernels, and BCs for neutron diffusion, NOT the variables, kernels, and BCs for precursor tracking. To generate these, see PrecursorAction.
                                                                                                      Overview
                                                                                                      NtAction greatly reduces input file length and complexity by automatically setting up variables, kernels, and BCs for the neutron diffusion equations. When including only the required input parameters, this action constructs the neutron group variables and their associated kernels: SigmaR, GroupDiffusion, InScatter, and CoupledFissionKernel. With account_delayed set to True, DelayedNeutronSource is also constructed, otherwise this kernel is not constructed and the simulation does not consider the delayed neutron precursor effects on the neutron flux distributions.
                                                                                                      For more information regarding the use of NtAction please refer to the tutorials located here, specifically the Multiphysics Reactor Simulations section.
                                                                                                      Example Input File Syntax
                                                                                                      An example input file without the NtAction, showing only the portion affected by the action:
                                                                                                      [Variables]
   [group1]
     order = FIRST
     family = LAGRANGE
@@ -81,14 +81,14 @@
     variable = group2
   []
 []
-
                                                                                                      (tutorial/eigenvalue/nts.i)
                                                                                                      And then the same information created with the NtAction:
                                                                                                      [Nt]
+
                                                                                                      (tutorial/eigenvalue/nts.i)
                                                                                                      And then the same information created with the NtAction:
                                                                                                      [Nt]
   var_name_base = group
   vacuum_boundaries = 'fuel_bottom mod_bottom right fuel_top mod_top'
   pre_blocks = '0'
   create_temperature_var = false
   eigen = true
 []
-
                                                                                                      (tutorial/eigenvalue/nts-action.i)
                                                                                                      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
                                                                                                      • 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, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS
                                                                                                        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_bc_typemarshakWhether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.
                                                                                                        Default:marshak
                                                                                                        C++ Type:MooseEnum
                                                                                                        Options:marshak, mark, milne
                                                                                                        Controllable:No
                                                                                                        Description:Whether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.
                                                                                                      • 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
                                                                                                      • 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.
                                                                                                      Advanced Parameters

                                                                                                      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

                                                                                                      • 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, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS

                                                                                                        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_bc_typemarshakWhether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                        Default:marshak

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:marshak, mark, milne

                                                                                                        Controllable:No

                                                                                                        Description:Whether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                      • 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

                                                                                                      • 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.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file +
                                                                                                      Close
                                                                                                      \ No newline at end of file diff --git a/source/actions/PrecursorAction.html b/source/actions/PrecursorAction.html index b21f21cb7..c9a4b1a64 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

                                                                                                      • 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, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS

                                                                                                        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

                                                                                                      • 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.

                                                                                                      Advanced 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

                                                                                                      • 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, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS

                                                                                                        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

                                                                                                      • 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.

                                                                                                      Advanced Parameters

                                                                                                      \ No newline at end of file diff --git a/source/auxkernels/ConstantDifferenceAux.html b/source/auxkernels/ConstantDifferenceAux.html index 13251e3b2..1be2e8b3f 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 03974a9b2..fba140c22 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 fcaef61ca..275740f1e 100644 --- a/source/auxkernels/FissionHeatSourceAux.html +++ b/source/auxkernels/FissionHeatSourceAux.html @@ -1,18 +1,13 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 86b256a41..28e2e10de 100644 --- a/source/auxkernels/FissionHeatSourceTransientAux.html +++ b/source/auxkernels/FissionHeatSourceTransientAux.html @@ -1,32 +1,39 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 281235a45..c55d8c512 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 9bd287f11..0b46741cc 100644 --- a/source/auxkernels/MatDiffusionAux.html +++ b/source/auxkernels/MatDiffusionAux.html @@ -1,18 +1,13 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 a3243fc7a..481449be0 100644 --- a/source/auxkernels/ModeratorHeatSourceTransientAux.html +++ b/source/auxkernels/ModeratorHeatSourceTransientAux.html @@ -1,32 +1,39 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 142d7ec0f..e76a5e13b 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 4cc3eccc8..e7c8f42fa 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 fa5a866dc..986ebe189 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 0666c2393..f18720a27 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 9ba7dee27..7891dee6c 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 67a5ba278..fb4c2d3b8 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 8db246d15..acaf92c6e 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 3cb0bf2cc..336d801e0 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 e3c4f57b8..c3278f744 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 33a7016e9..651a44707 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 8f50df8a6..f91e8150f 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 6504f1cab..dc6188c19 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 9bf8673ea..e51b01ac4 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 98d110dd8..8b40a8a5c 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 f4bdf5d37..5128d1a82 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 685329cc4..8d4c1cb50 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 c3926dff6..49d7ea8e1 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 1affa1c98..a2b57b679 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 febecdcb4..dd3928064 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 51a929bdb..835270988 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 cb24314b2..64b00cc19 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 5d4e9fc22..c0b292d9d 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 b63c0a95a..d68e76c6f 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 963609218..fa5224a2e 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 afdef7257..7cde8347d 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 cec8ab6bc..00d47adbf 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 ed7cfc0b0..6c41e3aa7 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 2a9bcead8..39cff45b0 100644 --- a/source/bcs/ScalarAdvectionArtDiffNoBCBC.html +++ b/source/bcs/ScalarAdvectionArtDiffNoBCBC.html @@ -1,4 +1,4 @@ -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 ee0b22cc7..3582acc1e 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 3d10d1881..fd75e8dd6 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 99b859cde..308a35653 100644 --- a/source/bcs/VacuumConcBC.html +++ b/source/bcs/VacuumConcBC.html @@ -1,8 +1,8 @@ -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:

                                                                                                      The value of varies depending on the BC type selected using the vacuum_bc_type parameter. The available options are:

                                                                                                      1. Marshak:

                                                                                                      2. Mark:

                                                                                                      3. Milne:

                                                                                                      The Marshak and Mark BCs are derived from vacuum boundary condition approximations using and transport methods, respectively. The Milne BC is derived from the exact analytical solution of the Milne problem (Placzek and Seidel, 1947) and has been proven to be accurate for a wide range of diffusive problems (Rulko et al., 1995).

                                                                                                      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.

                                                                                                      • vacuum_bc_typemarshakWhether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                        Default:marshak

                                                                                                        C++ Type:MooseEnum

                                                                                                        Options:marshak, mark, milne

                                                                                                        Controllable:No

                                                                                                        Description:Whether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                      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

                                                                                                      References

                                                                                                      1. G. Placzek and W. Seidel. +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:

                                                                                                        The value of varies depending on the BC type selected using the vacuum_bc_type parameter. The available options are:

                                                                                                        1. Marshak:

                                                                                                        2. Mark:

                                                                                                        3. Milne:

                                                                                                        The Marshak and Mark BCs are derived from vacuum boundary condition approximations using and transport methods, respectively. The Milne BC is derived from the exact analytical solution of the Milne problem (Placzek and Seidel, 1947) and has been proven to be accurate for a wide range of diffusive problems (Rulko et al., 1995).

                                                                                                        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_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.

                                                                                                        • 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.

                                                                                                        • vacuum_bc_typemarshakWhether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                          Default:marshak

                                                                                                          C++ Type:MooseEnum

                                                                                                          Options:marshak, mark, milne

                                                                                                          Controllable:No

                                                                                                          Description:Whether to apply Marshak, Mark, or Milne vacuum boundary conditions. Defaults to Marshak.

                                                                                                        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

                                                                                                        References

                                                                                                        1. G. Placzek and W. Seidel. Milne's Problem in Transport Theory. Physical Review, 72(7):550–555, October 1947. Publisher: American Physical Society. -URL: https://link.aps.org/doi/10.1103/PhysRev.72.550 (visited on 2024-05-31), doi:10.1103/PhysRev.72.550.[BibTeX]
                                                                                                      \ No newline at end of file +
                                                                                                      Close
                                                                                                      \ No newline at end of file diff --git a/source/bcs/VelocityFunctionOutflowBC.html b/source/bcs/VelocityFunctionOutflowBC.html index 183584a12..b10cbd217 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 8d60cae54..5ee317446 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 a586f5e0b..9bf977d4a 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 279f79ab8..ebd494161 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 fa99728e2..6dda9b49e 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 8f80489b6..a3bbcbc54 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 4d6d68bc7..11c10cbec 100644 --- a/source/dgkernels/DGTurbulentDiffusion.html +++ b/source/dgkernels/DGTurbulentDiffusion.html @@ -1,4 +1,94 @@ -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 bcd65a158..8602d86f8 100644 --- a/source/dirackernels/DiracHX.html +++ b/source/dirackernels/DiracHX.html @@ -1,153 +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 b591b150f..137290c15 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 3b9226924..651a5f7c0 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 fdc694bbb..97032bc29 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 5650db7c2..56bca0db6 100644 --- a/source/kernels/CoupledFissionKernel.html +++ b/source/kernels/CoupledFissionKernel.html @@ -1,7 +1,8 @@ -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 6e9bb08cf..24a7b01e5 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 0115e9d2d..80064e65a 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 d2c55b496..fb4de0647 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 6584276fa..55b2bbb97 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_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.

                                                                                                      • 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 69866e52f..8a75203ec 100644 --- a/source/kernels/DelayedNeutronSource.html +++ b/source/kernels/DelayedNeutronSource.html @@ -1,7 +1,8 @@ -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 df92aad19..82cca07a6 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_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.

                                                                                                      • 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 0e06a4db2..8c5981bf2 100644 --- a/source/kernels/FissionHeatSource.html +++ b/source/kernels/FissionHeatSource.html @@ -1,18 +1,13 @@ -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 b1518cba5..ef532d984 100644 --- a/source/kernels/GammaHeatSource.html +++ b/source/kernels/GammaHeatSource.html @@ -1,128 +1,60 @@ -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 46da3fcbb..8a2d46178 100644 --- a/source/kernels/GroupDiffusion.html +++ b/source/kernels/GroupDiffusion.html @@ -1,7 +1,8 @@ -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 7ccfebd18..447131c8d 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 5cbc2e07a..cbaee510c 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 b6210e314..a90a38356 100644 --- a/source/kernels/INSADEnergyTurbulentDiffusion.html +++ b/source/kernels/INSADEnergyTurbulentDiffusion.html @@ -1,4 +1,91 @@ -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 952043caf..90b7e8ec6 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 ad52fd960..e4d079894 100644 --- a/source/kernels/INSBoussinesqBodyForce.html +++ b/source/kernels/INSBoussinesqBodyForce.html @@ -1,395 +1,540 @@ -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 1b6cdd7cf..9c593766b 100644 --- a/source/kernels/InScatter.html +++ b/source/kernels/InScatter.html @@ -1,7 +1,145 @@ -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 fd9d2352c..36dca9f26 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 6f6e9bb82..0151d16e8 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 08fa3fd7e..25b2d721f 100644 --- a/source/kernels/NtTimeDerivative.html +++ b/source/kernels/NtTimeDerivative.html @@ -1,7 +1,8 @@ -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 035290593..5179ed570 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 2841fdc87..66f6e67c1 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 c7be7f026..9e6097c18 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 383f9a99e..6db615cc1 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 18b7386e4..e87ea0f5a 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 0c7faaff6..5d8aaedc5 100644 --- a/source/kernels/ScalarAdvectionArtDiff.html +++ b/source/kernels/ScalarAdvectionArtDiff.html @@ -1,243 +1,113 @@ -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 51a626eb4..b9ddec127 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 7a8fe3e68..4529b0674 100644 --- a/source/kernels/SigmaR.html +++ b/source/kernels/SigmaR.html @@ -1,7 +1,145 @@ -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 d51e5620a..3e8532b7a 100644 --- a/source/kernels/TransientFissionHeatSource.html +++ b/source/kernels/TransientFissionHeatSource.html @@ -1,128 +1,60 @@ -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 cc82c7fa8..fba6773ee 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 3018d2662..65fe8ef39 100644 --- a/source/materials/CammiFuel.html +++ b/source/materials/CammiFuel.html @@ -1,181 +1,25 @@ -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 c3a18e0b3..2ab7d8f26 100644 --- a/source/materials/CammiModerator.html +++ b/source/materials/CammiModerator.html @@ -1,181 +1,25 @@ -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 ddf18e3e1..c0fcd1825 100644 --- a/source/materials/GenericMoltresMaterial.html +++ b/source/materials/GenericMoltresMaterial.html @@ -1,7 +1,8 @@ -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 c4d08cbd3..6b886cd04 100644 --- a/source/materials/GraphiteTwoGrpXSFunctionMaterial.html +++ b/source/materials/GraphiteTwoGrpXSFunctionMaterial.html @@ -1,234 +1,329 @@ -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 9a0ca9d10..436a47684 100644 --- a/source/materials/MoltresJsonMaterial.html +++ b/source/materials/MoltresJsonMaterial.html @@ -1,11 +1,100 @@ -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 c689e98eb..fc44a471f 100644 --- a/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html +++ b/source/materials/MsreFuelTwoGrpXSFunctionMaterial.html @@ -1,234 +1,329 @@ -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 3f01231f4..afb560b25 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 1128ed49a..19dc55c1b 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 885a30459..895092234 100644 --- a/source/materials/RoddedMaterial.html +++ b/source/materials/RoddedMaterial.html @@ -1,4 +1,4 @@ -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 9ccbb8e5f..b201a3abd 100644 --- a/source/materials/SATauMaterial.html +++ b/source/materials/SATauMaterial.html @@ -1,4 +1,94 @@ -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 244a3a949..6377fe0a5 100644 --- a/source/materials/SATauStabilized3Eqn.html +++ b/source/materials/SATauStabilized3Eqn.html @@ -1,4 +1,91 @@ -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 817709f73..57631da5e 100644 --- a/source/postprocessors/AverageFissionHeat.html +++ b/source/postprocessors/AverageFissionHeat.html @@ -1,117 +1,67 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 e0338a8bb..ec824b5a7 100644 --- a/source/postprocessors/DivisionPostprocessor.html +++ b/source/postprocessors/DivisionPostprocessor.html @@ -1,117 +1,67 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 e9eed1105..becfbfdc3 100644 --- a/source/postprocessors/ElementL2Diff.html +++ b/source/postprocessors/ElementL2Diff.html @@ -1,4 +1,4 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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_absolute_valueFalseWhether to use abolsute value of the variable or not

                                                                                                        Default:False

                                                                                                        C++ Type:bool

                                                                                                        Controllable:No

                                                                                                        Description:Whether to use abolsute value of the variable or not

                                                                                                      • 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 b7dde11d5..bd0c02831 100644 --- a/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissHeatPostprocessor.html @@ -1,199 +1,231 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 aa49fdf16..b4abe614f 100644 --- a/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissNtsPostprocessor.html @@ -1,4 +1,4 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 201aa7ac0..3aad4884d 100644 --- a/source/postprocessors/ElmIntegTotFissPostprocessor.html +++ b/source/postprocessors/ElmIntegTotFissPostprocessor.html @@ -1,92 +1,4 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 81ae52abb..3ab5ff80c 100644 --- a/source/postprocessors/IntegralNewVariablePostprocessor.html +++ b/source/postprocessors/IntegralNewVariablePostprocessor.html @@ -1,117 +1,67 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 7bc39bf8a..3761b158b 100644 --- a/source/postprocessors/IntegralOldVariablePostprocessor.html +++ b/source/postprocessors/IntegralOldVariablePostprocessor.html @@ -1,117 +1,67 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 0537435cb..7c85e2c31 100644 --- a/source/postprocessors/LimitK.html +++ b/source/postprocessors/LimitK.html @@ -1,16 +1,16 @@ -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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 6b63d1859..b186dd15c 100644 --- a/source/postprocessors/SideWeightedIntegralPostprocessor.html +++ b/source/postprocessors/SideWeightedIntegralPostprocessor.html @@ -1,5 +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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 136db7a5c..6f9afbc02 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 37bbe3ffd..4b2fa34ca 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 6e04672aa..366cd2bfd 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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, POSTCHECK, 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 b876a9c18..d4bb2e0b3 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 b389fde5e..552720e1b 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 8fd2708d4..ade60e0c7 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