![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters.h>
Public Types | |
| enum class | RheologicalModel : std::int8_t { powerlaw , carreau , newtonian , phase_change } |
| enum class | DensityModel : std::int8_t { constant , isothermal_ideal_gas } |
| enum class | SpecificHeatModel : std::int8_t { constant , phase_change } |
| enum class | ThermalConductivityModel : std::int8_t { constant , linear , phase_change } |
| enum class | ThermalExpansionModel : std::int8_t { constant , phase_change } |
| enum class | TracerDiffusivityModel : std::int8_t { constant , immersed_boundary_tanh , immersed_boundary_gaussian } |
| enum class | TracerReactionPrefactorModel : std::int8_t { none , constant , immersed_boundary_tanh , immersed_boundary_gaussian } |
| enum class | ElectricConductivityModel : std::int8_t { constant , polynomial } |
| enum class | ElectricPermittivityModel : std::int8_t { constant , polynomial } |
| enum class | MagneticPermeabilityModel : std::int8_t { constant , polynomial } |
Public Member Functions | |
| Material ()=default | |
| void | declare_parameters (ParameterHandler &prm, const std::string &material_prefix, unsigned int id) const |
| void | parse_parameters (ParameterHandler &prm, const std::string &material_prefix, const unsigned int id, const Dimensionality &dimensions) |
Material - Class that defines the physical property of a material. Generally a material will be a fluid, but for conjugated heat transfer, this may also be a solid.
Definition at line 593 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| isothermal_ideal_gas | |
Definition at line 661 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| polynomial | |
Definition at line 702 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| polynomial | |
Definition at line 708 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| polynomial | |
Definition at line 714 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| powerlaw | |
| carreau | |
| newtonian | |
| phase_change | |
Definition at line 652 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| phase_change | |
Definition at line 668 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| linear | |
| phase_change | |
Definition at line 674 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| phase_change | |
Definition at line 681 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| constant | |
| immersed_boundary_tanh | |
| immersed_boundary_gaussian | |
Definition at line 687 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| none | |
| constant | |
| immersed_boundary_tanh | |
| immersed_boundary_gaussian | |
Definition at line 694 of file parameters.h.
|
default |
| void Parameters::Material::declare_parameters | ( | ParameterHandler & | prm, |
| const std::string & | material_prefix, | ||
| unsigned int | id ) const |
Declare the parameters for a material.
| [in,out] | prm | The parameter handler object. |
| [in] | material_prefix | Prefix used for this material's subsection. |
| [in] | id | Identifier of the material. |
Definition at line 1349 of file parameters.cc.
References declare_enum_entry(), density, density_model, electric_conductivity, electric_conductivity_model, electric_conductivity_polynomial_coefficients, electric_permittivity_imag, electric_permittivity_imag_polynomial_coefficients, electric_permittivity_model, electric_permittivity_real, electric_permittivity_real_polynomial_coefficients, immersed_solid_gaussian_parameters, immersed_solid_tanh_parameters, isothermal_ideal_gas_density_parameters, k_A0, k_A1, kinematic_viscosity, magnetic_permeability_imag, magnetic_permeability_imag_polynomial_coefficients, magnetic_permeability_model, magnetic_permeability_real, magnetic_permeability_real_polynomial_coefficients, non_newtonian_parameters, phase_change_parameters, rheological_model, specific_heat, specific_heat_model, thermal_conductivity, thermal_conductivity_model, thermal_expansion, thermal_expansion_model, tracer_diffusivity, tracer_diffusivity_model, tracer_reaction_constant, tracer_reaction_order, tracer_reaction_prefactor_model, and tracer_reaction_threshold.
| void Parameters::Material::parse_parameters | ( | ParameterHandler & | prm, |
| const std::string & | material_prefix, | ||
| const unsigned int | id, | ||
| const Dimensionality & | dimensions ) |
Parse the parameters for a material.
| [in] | prm | The parameter handler object. |
| [in] | material_prefix | Prefix used for this material's subsection. |
| [in] | id | Identifier of the material. |
| [in] | dimensions | Dimensionality used to interpret the parameter units. |
Definition at line 1576 of file parameters.cc.
References constant, convert_string_to_vector(), density, density_model, Parameters::Dimensionality::density_scaling, Parameters::Dimensionality::diffusivity_scaling, electric_conductivity, electric_conductivity_model, electric_conductivity_polynomial_coefficients, electric_permittivity_imag, electric_permittivity_imag_polynomial_coefficients, electric_permittivity_model, electric_permittivity_real, electric_permittivity_real_polynomial_coefficients, immersed_solid_gaussian_parameters, immersed_solid_tanh_parameters, isothermal_ideal_gas_density_parameters, k_A0, k_A1, kinematic_viscosity, magnetic_permeability_imag, magnetic_permeability_imag_polynomial_coefficients, magnetic_permeability_model, magnetic_permeability_real, magnetic_permeability_real_polynomial_coefficients, non_newtonian_parameters, phase_change_parameters, polynomial, rheological_model, specific_heat, specific_heat_model, Parameters::Dimensionality::specific_heat_scaling, string_to_enum(), Parameters::Dimensionality::temperature, thermal_conductivity, thermal_conductivity_model, Parameters::Dimensionality::thermal_conductivity_scaling, thermal_expansion, thermal_expansion_model, tracer_diffusivity, tracer_diffusivity_model, tracer_reaction_constant, tracer_reaction_order, tracer_reaction_prefactor_model, tracer_reaction_threshold, and Parameters::Dimensionality::viscosity_scaling.
| double Parameters::Material::density = 1. |
Definition at line 628 of file parameters.h.
| enum Parameters::Material::DensityModel Parameters::Material::density_model = DensityModel::constant |
| double Parameters::Material::electric_conductivity = 0. |
Electric_conductivity.
Material parameters for the electromagnetics solver. Only the permittivity and the permeability are complex-valued because they can store electromagnetic energy in the medium and also dissipate it.
Definition at line 737 of file parameters.h.
| enum Parameters::Material::ElectricConductivityModel Parameters::Material::electric_conductivity_model = ElectricConductivityModel::constant |
| std::vector<double> Parameters::Material::electric_conductivity_polynomial_coefficients {0.} |
Definition at line 738 of file parameters.h.
| double Parameters::Material::electric_permittivity_imag = 0. |
Definition at line 748 of file parameters.h.
| std::vector<double> Parameters::Material::electric_permittivity_imag_polynomial_coefficients {0.} |
Definition at line 750 of file parameters.h.
| enum Parameters::Material::ElectricPermittivityModel Parameters::Material::electric_permittivity_model = ElectricPermittivityModel::constant |
| double Parameters::Material::electric_permittivity_real = 1. |
Electric_permittivity.
Definition at line 747 of file parameters.h.
| std::vector<double> Parameters::Material::electric_permittivity_real_polynomial_coefficients {1.} |
Definition at line 749 of file parameters.h.
| ImmersedSolidGaussianParameters Parameters::Material::immersed_solid_gaussian_parameters |
Definition at line 726 of file parameters.h.
| ImmersedSolidTanhParameters Parameters::Material::immersed_solid_tanh_parameters |
Definition at line 722 of file parameters.h.
| IsothermalIdealGasDensityParameters Parameters::Material::isothermal_ideal_gas_density_parameters |
Definition at line 666 of file parameters.h.
| double Parameters::Material::k_A0 = 0. |
Definition at line 729 of file parameters.h.
| double Parameters::Material::k_A1 = 0. |
Definition at line 730 of file parameters.h.
| double Parameters::Material::kinematic_viscosity = 1. |
Definition at line 626 of file parameters.h.
| double Parameters::Material::magnetic_permeability_imag = 0. |
Definition at line 742 of file parameters.h.
| std::vector<double> Parameters::Material::magnetic_permeability_imag_polynomial_coefficients {0.} |
Definition at line 744 of file parameters.h.
| enum Parameters::Material::MagneticPermeabilityModel Parameters::Material::magnetic_permeability_model = MagneticPermeabilityModel::constant |
| double Parameters::Material::magnetic_permeability_real = 1. |
Magnetic_permeability.
Definition at line 741 of file parameters.h.
| std::vector<double> Parameters::Material::magnetic_permeability_real_polynomial_coefficients {1.} |
Definition at line 743 of file parameters.h.
| NonNewtonian Parameters::Material::non_newtonian_parameters |
Definition at line 659 of file parameters.h.
| PhaseChange Parameters::Material::phase_change_parameters |
Definition at line 649 of file parameters.h.
| enum Parameters::Material::RheologicalModel Parameters::Material::rheological_model = RheologicalModel::newtonian |
| double Parameters::Material::specific_heat = 1. |
Definition at line 630 of file parameters.h.
| enum Parameters::Material::SpecificHeatModel Parameters::Material::specific_heat_model = SpecificHeatModel::constant |
| double Parameters::Material::thermal_conductivity = 1. |
Definition at line 632 of file parameters.h.
| enum Parameters::Material::ThermalConductivityModel Parameters::Material::thermal_conductivity_model = ThermalConductivityModel::constant |
| double Parameters::Material::thermal_expansion = 1. |
Definition at line 634 of file parameters.h.
| enum Parameters::Material::ThermalExpansionModel Parameters::Material::thermal_expansion_model = ThermalExpansionModel::constant |
| double Parameters::Material::tracer_diffusivity = 0. |
Definition at line 637 of file parameters.h.
| enum Parameters::Material::TracerDiffusivityModel Parameters::Material::tracer_diffusivity_model = TracerDiffusivityModel::constant |
| double Parameters::Material::tracer_reaction_constant = 0. |
Definition at line 640 of file parameters.h.
| double Parameters::Material::tracer_reaction_order = 1. |
Definition at line 642 of file parameters.h.
| enum Parameters::Material::TracerReactionPrefactorModel Parameters::Material::tracer_reaction_prefactor_model = TracerReactionPrefactorModel::constant |
| double Parameters::Material::tracer_reaction_threshold = 1e-8 |
Definition at line 646 of file parameters.h.