slippy.contact.Lubricant¶
- class slippy.contact.Lubricant(name: str, models: Optional[collections.OrderedDict] = None, constant_viscosity: Optional[float] = None, constant_density: Optional[float] = None)[source]¶
A class for describing lubricant behaviours
- Parameters
name (str) – The name of the lubricant, used for output and error messages
models (OrderedDict) – The sub models to solve
constant_viscosity (float, optional (None)) – The viscosity, should only be supplied if the viscosity is constant, otherwise an appropriate model should be used. This adds both viscosity and nd_viscosity models.
constant_density (float, optional (None)) – The density, should only be supplied if the density is constant, otherwise an appropriate model should be used. This adds both density and nd_density models
- sub_models¶
The sub models which will be executed on each iteration of the reynolds solver
- Type
OrderedDict
- built_in_models¶
A list of all the named sub models built in to slippy, these are all available in slippy.contact.*model_name*
- Type
list
Notes
Examples
- __init__(name: str, models: Optional[collections.OrderedDict] = None, constant_viscosity: Optional[float] = None, constant_density: Optional[float] = None)[source]¶
Methods
__init__(name[, models, constant_viscosity, ...])add_sub_model(parameter, function)Adds a lubricant sub model to be solved on each iteration of the solver
data_check(current_state)Use introspection to check that all sub models will solve properly
solve_sub_models(current_state)- param current_state
The current state of the model
Attributes