Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
EvaporationModel Class Referenceabstract

#include <evaporation_model.h>

Inheritance diagram for EvaporationModel:
[legend]

Public Member Functions

 EvaporationModel ()=default
virtual ~EvaporationModel ()=default
bool depends_on (const field &id)
virtual double mass_flux (const std::map< field, double > &field_values)=0
virtual void mass_flux (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &mass_flux_vector)=0
virtual double heat_flux (const std::map< field, double > &field_values)=0
virtual void heat_flux (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &heat_flux_vector)=0
virtual double heat_flux_jacobian (const std::map< field, double > &field_values, const field id)=0
virtual void heat_flux_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)=0
virtual double momentum_flux (const std::map< field, double > &field_values)=0
virtual void momentum_flux (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &momentum_flux_vector)=0
virtual double momentum_flux_jacobian (const std::map< field, double > &field_values, const field id)=0
virtual void momentum_flux_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)=0

Static Public Member Functions

static std::shared_ptr< EvaporationModel > model_cast (const Parameters::Evaporation &evaporation_parameters)

Protected Attributes

std::map< field, bool > model_depends_on

Detailed Description

EvaporationModel. Abstract class that allows to calculate the evaporation mass, heat and momentum fluxes. This model computes all the terms required for the assembly of the governing equations, i.e., Navier-Stokes momentum and energy, when evaporation is considered. The former terms are the momentum flux (i.e., pressure) acting on the evaporative front in the normal direction, the heat flux, acting at the same location as a cooling term, and the fluxes' jacobian, if required.

The EvaporativeModel is the parent class, and its children are specific types of evaporative models, e.g., constant, temperature dependent. The selected model is instantiated in the assemblers' constructor (NavierStokesCLSAssemblerEvaporation and/or HeatTransferAssemblerCLSEvaporation), using the model_cast method according to the evaporation model parameters.

The assemblers call the required method of the EvaporationModel for either the assembly of the rhs or matrix terms. Hence, no matter the selected evaporation model, the same assembler is called, avoiding repetitions of the assembler classes.

Definition at line 36 of file evaporation_model.h.

Constructor & Destructor Documentation

◆ EvaporationModel()

EvaporationModel::EvaporationModel ( )
default

◆ ~EvaporationModel()

virtual EvaporationModel::~EvaporationModel ( )
virtualdefault

Default virual destructor. Does not do anything.

Member Function Documentation

◆ depends_on()

bool EvaporationModel::depends_on ( const field & id)
inline

Returns true if the EvaporationModel depends on a field, false if not.

Parameters
idIdentifier of the field for which the function is called.
Returns
Boolean stating if the EvaporationModel depends on the field.

Definition at line 62 of file evaporation_model.h.

References model_depends_on.

◆ heat_flux() [1/2]

virtual double EvaporationModel::heat_flux ( const std::map< field, double > & field_values)
pure virtual

heat_flux Calculates the value of the evaporation heat flux.

Parameters
field_valuesMap storing the values of the various fields on which the heat flux may depend.
Returns
Value of the heat flux calculated with the field_values

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ heat_flux() [2/2]

virtual void EvaporationModel::heat_flux ( const std::map< field, std::vector< double > > & field_vectors,
std::vector< double > & heat_flux_vector )
pure virtual

heat_flux Calculates the values of the evaporation heat flux for multiple points.

Parameters
field_vectorsMap storing the vectors of the values for each field on which the heat flux may depend. Each vector contains the field values at the points of interest.
heat_flux_vectorVector of heat flux values.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ heat_flux_jacobian() [1/2]

virtual double EvaporationModel::heat_flux_jacobian ( const std::map< field, double > & field_values,
const field id )
pure virtual

heat_flux_jacobian Calculates the jacobian (the partial derivative) of the evaporation heat flux with respect to a field.

Parameters
field_valuesMap storing the values of the various fields on which the heat flux evaluated at a point may depend.
idIdentifier of the field with respect to which the jacobian should be calculated.
Returns
Value of the partial derivative of the heat flux with respect to the field.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ heat_flux_jacobian() [2/2]

virtual void EvaporationModel::heat_flux_jacobian ( const std::map< field, std::vector< double > > & field_vectors,
const field id,
std::vector< double > & jacobian_vector )
pure virtual

heat_flux_jacobian Calculates the derivative of the evaporation heat flux with respect to a field for multiple points.

Parameters
field_vectorsMap storing the vectors of the values for each field on which the heat flux may depend. Each vector contains the field values at the points of interest.
idIdentifier of the field with respect to which a derivative should be calculated.
jacobian_vectorVector of the values of the derivative of the heat flux with respect to the field.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ mass_flux() [1/2]

virtual double EvaporationModel::mass_flux ( const std::map< field, double > & field_values)
pure virtual

mass_flux Calculates the value of the evaporation mass flux.

Parameters
field_valuesMap storing the values of the various fields on which the mass flux may depend.
Returns
Value of the flux calculated with the field_values.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ mass_flux() [2/2]

virtual void EvaporationModel::mass_flux ( const std::map< field, std::vector< double > > & field_vectors,
std::vector< double > & mass_flux_vector )
pure virtual

mass_flux Calculates the values of the evaporation mass flux for multiple points.

Parameters
field_vectorsMap storing the vectors of the values for each field on which the mass flux may depend. Each vector contains the field values at the points of interest.
mass_flux_vectorVector of mass flux values.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ model_cast()

std::shared_ptr< EvaporationModel > EvaporationModel::model_cast ( const Parameters::Evaporation & evaporation_parameters)
static

Instantiates and returns a pointer to an EvaporationModel object by casting it to the proper child class.

Parameters
evaporation_parametersEvaporation model parameters.
Returns
Pointer to the instantiated EvaporationModel.

Definition at line 7 of file evaporation_model.cc.

References Parameters::Evaporation::evaporative_mass_flux_model_type.

◆ momentum_flux() [1/2]

virtual double EvaporationModel::momentum_flux ( const std::map< field, double > & field_values)
pure virtual

momentum_flux Calculates the value of the evaporation momentum flux.

Parameters
field_valuesMap storing the values of the various fields on which the momentum flux may depend.
Returns
Value of the momentum flux calculated with the field_values.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ momentum_flux() [2/2]

virtual void EvaporationModel::momentum_flux ( const std::map< field, std::vector< double > > & field_vectors,
std::vector< double > & momentum_flux_vector )
pure virtual

momentum_flux Calculates the values of the evaporation momentum flux for multiple points.

Parameters
field_vectorsMap storing the vectors of the values for each field on which the evaporation momentum flux may depend. Each vector contains the field values at the points of interest.
momentum_flux_vectorVector of momentum flux values.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ momentum_flux_jacobian() [1/2]

virtual double EvaporationModel::momentum_flux_jacobian ( const std::map< field, double > & field_values,
const field id )
pure virtual

momentum_flux_jacobian Calculates the jacobian (the partial derivative) of the evaporation momentum flux with respect to a field.

Parameters
field_valuesMap storing the values of the various fields on which the momentum flux may depend.
idIdentifier of the field with respect to which the jacobian should be calculated.
Returns
Value of the partial derivative of the momentum flux with respect to the field.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

◆ momentum_flux_jacobian() [2/2]

virtual void EvaporationModel::momentum_flux_jacobian ( const std::map< field, std::vector< double > > & field_vectors,
const field id,
std::vector< double > & jacobian_vector )
pure virtual

momentum_flux_jacobian Calculates the derivative of the evaporation momentum flux with respect to a field for multiple points.

Parameters
field_vectorsMap storing the vectors of the values for each field on which the momentum flux may depend. Each vector contains the field values at the points of interest.
idIdentifier of the field with respect to which a derivative should be calculated.
jacobian_vectorVector of the value of the derivative of the momentum flux with respect to the field.

Implemented in EvaporationModelConstant, and EvaporationModelTemperature.

Member Data Documentation

◆ model_depends_on

std::map<field, bool> EvaporationModel::model_depends_on
protected

Definition at line 193 of file evaporation_model.h.


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