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

#include <surface_tension_model.h>

Inheritance diagram for SurfaceTensionConstant:
[legend]

Public Member Functions

 SurfaceTensionConstant (const double p_surface_tension_coefficient)
double value (const std::map< field, double > &) override
void vector_value (const std::map< field, std::vector< double > > &, std::vector< double > &property_vector) override
double jacobian (const std::map< field, double > &, field) override
void vector_jacobian (const std::map< field, std::vector< double > > &, const field, std::vector< double > &jacobian_vector) override
Public Member Functions inherited from SurfaceTensionModel
bool is_constant_surface_tension_model ()
Public Member Functions inherited from InterfacePropertyModel
 InterfacePropertyModel ()
virtual ~InterfacePropertyModel ()=default
bool depends_on (const field &id)
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)

Private Attributes

const double surface_tension_coefficient

Additional Inherited Members

Static Public Member Functions inherited from SurfaceTensionModel
static std::shared_ptr< SurfaceTensionModel > model_cast (const Parameters::MaterialInteractions &material_interaction_parameters)
Protected Attributes inherited from SurfaceTensionModel
bool surface_tension_is_constant = false
Protected Attributes inherited from InterfacePropertyModel
std::map< field, bool > model_depends_on

Detailed Description

Constant surface tension.

Definition at line 50 of file surface_tension_model.h.

Constructor & Destructor Documentation

◆ SurfaceTensionConstant()

SurfaceTensionConstant::SurfaceTensionConstant ( const double p_surface_tension_coefficient)
inline

Default constructor.

Definition at line 56 of file surface_tension_model.h.

References surface_tension_coefficient, and SurfaceTensionModel::surface_tension_is_constant.

Member Function Documentation

◆ jacobian()

double SurfaceTensionConstant::jacobian ( const std::map< field, double > & ,
field  )
inlineoverridevirtual

jacobian Calculates the jacobian (the partial derivative) of the surface tension coefficient with respect to a field

Parameters
field_valuesValue of the various fields on which the property may depend.
idIndicator of the field with respect to which the jacobian should be calculated.
Returns
value of the partial derivative of the surface tension coefficient with respect to the field.

Implements InterfacePropertyModel.

Definition at line 98 of file surface_tension_model.h.

◆ value()

double SurfaceTensionConstant::value ( const std::map< field, double > & )
inlineoverridevirtual

value Calculates the surface tension coefficient

Parameters
fields_valueValue of the various field on which the property may depend.
Returns
value of the physical property calculated with the fields_value

Implements InterfacePropertyModel.

Definition at line 69 of file surface_tension_model.h.

References surface_tension_coefficient.

◆ vector_jacobian()

void SurfaceTensionConstant::vector_jacobian ( const std::map< field, std::vector< double > > & ,
const field ,
std::vector< double > & jacobian_vector )
inlineoverridevirtual

vector_jacobian Calculates the derivative of the surface tension coefficient with respect to a field.

Parameters
field_vectorsVector for the values of the fields used to evaluate the property.
idIdentifier of the field with respect to which a derivative should be calculated.
jacobianvector of the value of the derivative of the surface tension coefficient with respect to the field id.

Implements InterfacePropertyModel.

Definition at line 115 of file surface_tension_model.h.

◆ vector_value()

void SurfaceTensionConstant::vector_value ( const std::map< field, std::vector< double > > & ,
std::vector< double > & property_vector )
inlineoverridevirtual

vector_value Calculates the vector of surface tension coefficient.

Parameters
field_vectorsVectors of the fields on which the surface tension coefficient may depend.
property_vectorVectors of the surface tension coefficient values

Implements InterfacePropertyModel.

Definition at line 81 of file surface_tension_model.h.

References surface_tension_coefficient.

Member Data Documentation

◆ surface_tension_coefficient

const double SurfaceTensionConstant::surface_tension_coefficient
private

Definition at line 124 of file surface_tension_model.h.


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