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

#include <surface_tension_model.h>

Inheritance diagram for SurfaceTensionModel:
[legend]

Public Member Functions

bool is_constant_surface_tension_model ()
Public Member Functions inherited from InterfacePropertyModel
 InterfacePropertyModel ()
virtual ~InterfacePropertyModel ()=default
bool depends_on (const field &id)
virtual double value (const std::map< field, double > &fields_value)=0
virtual void vector_value (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &property_vector)=0
virtual double jacobian (const std::map< field, double > &field_values, const field id)=0
virtual void vector_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)=0
double numerical_jacobian (const std::map< field, double > &field_values, const field id)
void vector_numerical_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)

Static Public Member Functions

static std::shared_ptr< SurfaceTensionModel > model_cast (const Parameters::MaterialInteractions &material_interaction_parameters)

Protected Attributes

bool surface_tension_is_constant = false
Protected Attributes inherited from InterfacePropertyModel
std::map< field, bool > model_depends_on

Detailed Description

Abstract class that allows to calculate the surface tension coefficient.

Definition at line 16 of file surface_tension_model.h.

Member Function Documentation

◆ is_constant_surface_tension_model()

bool SurfaceTensionModel::is_constant_surface_tension_model ( )
inline

is_constant_surface_tension_model Returns a boolean indicating if the model is a constant surface tension model.

Returns
Boolean value of if the model corresponds to a constant surface tension model.

Definition at line 37 of file surface_tension_model.h.

References surface_tension_is_constant.

◆ model_cast()

std::shared_ptr< SurfaceTensionModel > SurfaceTensionModel::model_cast ( const Parameters::MaterialInteractions & material_interaction_parameters)
static

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

Parameters
material_interaction_parametersParameters for the surface tension coefficient calculation

Definition at line 7 of file surface_tension_model.cc.

References Parameters::MaterialInteractions::linear, Parameters::MaterialInteractions::phase_change, Parameters::SurfaceTensionParameters::surface_tension_coefficient, Parameters::MaterialInteractions::surface_tension_model, and Parameters::MaterialInteractions::surface_tension_parameters.

Member Data Documentation

◆ surface_tension_is_constant

bool SurfaceTensionModel::surface_tension_is_constant = false
protected

Definition at line 43 of file surface_tension_model.h.


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