Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::Material Class Reference

#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)

Public Attributes

double kinematic_viscosity = 1.
double density = 1.
double specific_heat = 1.
double thermal_conductivity = 1.
double thermal_expansion = 1.
double tracer_diffusivity = 0.
double tracer_reaction_constant = 0.
double tracer_reaction_order = 1.
double tracer_reaction_threshold = 1e-8
PhaseChange phase_change_parameters
enum Parameters::Material::RheologicalModel rheological_model = RheologicalModel::newtonian
NonNewtonian non_newtonian_parameters
enum Parameters::Material::DensityModel density_model = DensityModel::constant
IsothermalIdealGasDensityParameters isothermal_ideal_gas_density_parameters
enum Parameters::Material::SpecificHeatModel specific_heat_model = SpecificHeatModel::constant
enum Parameters::Material::ThermalConductivityModel thermal_conductivity_model = ThermalConductivityModel::constant
enum Parameters::Material::ThermalExpansionModel thermal_expansion_model = ThermalExpansionModel::constant
enum Parameters::Material::TracerDiffusivityModel tracer_diffusivity_model = TracerDiffusivityModel::constant
enum Parameters::Material::TracerReactionPrefactorModel tracer_reaction_prefactor_model = TracerReactionPrefactorModel::constant
enum Parameters::Material::ElectricConductivityModel electric_conductivity_model = ElectricConductivityModel::constant
enum Parameters::Material::ElectricPermittivityModel electric_permittivity_model = ElectricPermittivityModel::constant
enum Parameters::Material::MagneticPermeabilityModel magnetic_permeability_model = MagneticPermeabilityModel::constant
ImmersedSolidTanhParameters immersed_solid_tanh_parameters
ImmersedSolidGaussianParameters immersed_solid_gaussian_parameters
double k_A0 = 0.
double k_A1 = 0.
double electric_conductivity = 0.
std::vector< double > electric_conductivity_polynomial_coefficients {0.}
double magnetic_permeability_real = 1.
double magnetic_permeability_imag = 0.
std::vector< double > magnetic_permeability_real_polynomial_coefficients {1.}
std::vector< double > magnetic_permeability_imag_polynomial_coefficients {0.}
double electric_permittivity_real = 1.
double electric_permittivity_imag = 0.
std::vector< double > electric_permittivity_real_polynomial_coefficients {1.}
std::vector< double > electric_permittivity_imag_polynomial_coefficients {0.}

Detailed Description

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.

Member Enumeration Documentation

◆ DensityModel

enum class Parameters::Material::DensityModel : std::int8_t
strong
Enumerator
constant 
isothermal_ideal_gas 

Definition at line 661 of file parameters.h.

◆ ElectricConductivityModel

enum class Parameters::Material::ElectricConductivityModel : std::int8_t
strong
Enumerator
constant 
polynomial 

Definition at line 702 of file parameters.h.

◆ ElectricPermittivityModel

enum class Parameters::Material::ElectricPermittivityModel : std::int8_t
strong
Enumerator
constant 
polynomial 

Definition at line 708 of file parameters.h.

◆ MagneticPermeabilityModel

enum class Parameters::Material::MagneticPermeabilityModel : std::int8_t
strong
Enumerator
constant 
polynomial 

Definition at line 714 of file parameters.h.

◆ RheologicalModel

enum class Parameters::Material::RheologicalModel : std::int8_t
strong
Enumerator
powerlaw 
carreau 
newtonian 
phase_change 

Definition at line 652 of file parameters.h.

◆ SpecificHeatModel

enum class Parameters::Material::SpecificHeatModel : std::int8_t
strong
Enumerator
constant 
phase_change 

Definition at line 668 of file parameters.h.

◆ ThermalConductivityModel

enum class Parameters::Material::ThermalConductivityModel : std::int8_t
strong
Enumerator
constant 
linear 
phase_change 

Definition at line 674 of file parameters.h.

◆ ThermalExpansionModel

enum class Parameters::Material::ThermalExpansionModel : std::int8_t
strong
Enumerator
constant 
phase_change 

Definition at line 681 of file parameters.h.

◆ TracerDiffusivityModel

enum class Parameters::Material::TracerDiffusivityModel : std::int8_t
strong
Enumerator
constant 
immersed_boundary_tanh 
immersed_boundary_gaussian 

Definition at line 687 of file parameters.h.

◆ TracerReactionPrefactorModel

enum class Parameters::Material::TracerReactionPrefactorModel : std::int8_t
strong
Enumerator
none 
constant 
immersed_boundary_tanh 
immersed_boundary_gaussian 

Definition at line 694 of file parameters.h.

Constructor & Destructor Documentation

◆ Material()

Parameters::Material::Material ( )
default

Member Function Documentation

◆ declare_parameters()

◆ parse_parameters()

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.

Parameters
[in]prmThe parameter handler object.
[in]material_prefixPrefix used for this material's subsection.
[in]idIdentifier of the material.
[in]dimensionsDimensionality 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.

Member Data Documentation

◆ density

double Parameters::Material::density = 1.

Definition at line 628 of file parameters.h.

◆ density_model

enum Parameters::Material::DensityModel Parameters::Material::density_model = DensityModel::constant

◆ electric_conductivity

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.

◆ electric_conductivity_model

enum Parameters::Material::ElectricConductivityModel Parameters::Material::electric_conductivity_model = ElectricConductivityModel::constant

◆ electric_conductivity_polynomial_coefficients

std::vector<double> Parameters::Material::electric_conductivity_polynomial_coefficients {0.}

Definition at line 738 of file parameters.h.

◆ electric_permittivity_imag

double Parameters::Material::electric_permittivity_imag = 0.

Definition at line 748 of file parameters.h.

◆ electric_permittivity_imag_polynomial_coefficients

std::vector<double> Parameters::Material::electric_permittivity_imag_polynomial_coefficients {0.}

Definition at line 750 of file parameters.h.

◆ electric_permittivity_model

enum Parameters::Material::ElectricPermittivityModel Parameters::Material::electric_permittivity_model = ElectricPermittivityModel::constant

◆ electric_permittivity_real

double Parameters::Material::electric_permittivity_real = 1.

Electric_permittivity.

Definition at line 747 of file parameters.h.

◆ electric_permittivity_real_polynomial_coefficients

std::vector<double> Parameters::Material::electric_permittivity_real_polynomial_coefficients {1.}

Definition at line 749 of file parameters.h.

◆ immersed_solid_gaussian_parameters

ImmersedSolidGaussianParameters Parameters::Material::immersed_solid_gaussian_parameters

Definition at line 726 of file parameters.h.

◆ immersed_solid_tanh_parameters

ImmersedSolidTanhParameters Parameters::Material::immersed_solid_tanh_parameters

Definition at line 722 of file parameters.h.

◆ isothermal_ideal_gas_density_parameters

IsothermalIdealGasDensityParameters Parameters::Material::isothermal_ideal_gas_density_parameters

Definition at line 666 of file parameters.h.

◆ k_A0

double Parameters::Material::k_A0 = 0.

Definition at line 729 of file parameters.h.

◆ k_A1

double Parameters::Material::k_A1 = 0.

Definition at line 730 of file parameters.h.

◆ kinematic_viscosity

double Parameters::Material::kinematic_viscosity = 1.

Definition at line 626 of file parameters.h.

◆ magnetic_permeability_imag

double Parameters::Material::magnetic_permeability_imag = 0.

Definition at line 742 of file parameters.h.

◆ magnetic_permeability_imag_polynomial_coefficients

std::vector<double> Parameters::Material::magnetic_permeability_imag_polynomial_coefficients {0.}

Definition at line 744 of file parameters.h.

◆ magnetic_permeability_model

enum Parameters::Material::MagneticPermeabilityModel Parameters::Material::magnetic_permeability_model = MagneticPermeabilityModel::constant

◆ magnetic_permeability_real

double Parameters::Material::magnetic_permeability_real = 1.

Magnetic_permeability.

Definition at line 741 of file parameters.h.

◆ magnetic_permeability_real_polynomial_coefficients

std::vector<double> Parameters::Material::magnetic_permeability_real_polynomial_coefficients {1.}

Definition at line 743 of file parameters.h.

◆ non_newtonian_parameters

NonNewtonian Parameters::Material::non_newtonian_parameters

Definition at line 659 of file parameters.h.

◆ phase_change_parameters

PhaseChange Parameters::Material::phase_change_parameters

Definition at line 649 of file parameters.h.

◆ rheological_model

enum Parameters::Material::RheologicalModel Parameters::Material::rheological_model = RheologicalModel::newtonian

◆ specific_heat

double Parameters::Material::specific_heat = 1.

Definition at line 630 of file parameters.h.

◆ specific_heat_model

enum Parameters::Material::SpecificHeatModel Parameters::Material::specific_heat_model = SpecificHeatModel::constant

◆ thermal_conductivity

double Parameters::Material::thermal_conductivity = 1.

Definition at line 632 of file parameters.h.

◆ thermal_conductivity_model

enum Parameters::Material::ThermalConductivityModel Parameters::Material::thermal_conductivity_model = ThermalConductivityModel::constant

◆ thermal_expansion

double Parameters::Material::thermal_expansion = 1.

Definition at line 634 of file parameters.h.

◆ thermal_expansion_model

enum Parameters::Material::ThermalExpansionModel Parameters::Material::thermal_expansion_model = ThermalExpansionModel::constant

◆ tracer_diffusivity

double Parameters::Material::tracer_diffusivity = 0.

Definition at line 637 of file parameters.h.

◆ tracer_diffusivity_model

enum Parameters::Material::TracerDiffusivityModel Parameters::Material::tracer_diffusivity_model = TracerDiffusivityModel::constant

◆ tracer_reaction_constant

double Parameters::Material::tracer_reaction_constant = 0.

Definition at line 640 of file parameters.h.

◆ tracer_reaction_order

double Parameters::Material::tracer_reaction_order = 1.

Definition at line 642 of file parameters.h.

◆ tracer_reaction_prefactor_model

enum Parameters::Material::TracerReactionPrefactorModel Parameters::Material::tracer_reaction_prefactor_model = TracerReactionPrefactorModel::constant

◆ tracer_reaction_threshold

double Parameters::Material::tracer_reaction_threshold = 1e-8

Definition at line 646 of file parameters.h.


The documentation for this class was generated from the following files: