Skip to content

Commit

Permalink
New interfaces and better documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wallytutor committed Jan 7, 2025
1 parent 4f21263 commit a79003a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 15 deletions.
5 changes: 5 additions & 0 deletions docs/src/manual/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,13 @@ AuChimiste.Composition

## Interfaces

The following interfaces are provided as a centralization of names for the package. Generally these functions will take an object with the type for which they implement the quantity associated with their name, and other relevant parameters, such as temperature, pressure, and/or an array of mass fractions. In all cases values are expected to be returned in SI units, as documented by each function.

```@docs
AuChimiste.density
AuChimiste.specific_heat
AuChimiste.enthalpy
AuChimiste.entropy
AuChimiste.thermal_conductivity
AuChimiste.viscosity
```
Expand Down
45 changes: 30 additions & 15 deletions src/interfaces.jl
Original file line number Diff line number Diff line change
@@ -1,34 +1,49 @@
# -*- coding: utf-8 -*-

"""
density(args...; kwargs...)
Evaluation of the density of a substance.
Its return value must be in ``kg\\cdotp{}m^{-3}``.
"""
function density end

"""
specific_heat(args...; kwargs...)
Common interface for evaluation of the specific heat of a substance.
Generally this function will take an object with the type for which it
implements the specific heat, a temperature, and maybe an array of
mass fractions. Its return value must be provided in standard SI units
of ``J\\cdotp{}kg^{-1}\\cdotp{}K^{-1}``.
Evaluation of the specific heat of a substance.
Its return value must be in ``J\\cdotp{}kg^{-1}\\cdotp{}K^{-1}``.
"""
function specific_heat end

"""
enthalpy(args...; kwargs...)
Evaluation of the enthalpy of a substance.
Its return value must be in ``J\\cdotp{}kg^{-1}``.
"""
function enthalpy end

"""
entropy(args...; kwargs...)
Evaluation of the entropy of a substance.
Its return value must be in ``J\\cdotp{}K^{-1}``.
"""
function entropy end

"""
thermal_conductivity(args...; kwargs...)
Common interface for evaluation of the thermal conductivity of a
substance. Generally this function will take an object with the type
for which it implements the thermal conductivity, a temperature, and
maybe an array of mass fractions. Its return value must be provided
in standard SI units of ``W\\cdotp{}m^{-1}\\cdotp{}K^{-1}``.
Evaluation of the thermal conductivity of a substance.
Its return value must be in ``W\\cdotp{}m^{-1}\\cdotp{}K^{-1}``.
"""
function thermal_conductivity end

"""
viscosity(args...; kwargs...)
Common interface for evaluation of the viscosity of a substance.
Generally this function will take an object with the type for which it
implements the viscosity, a temperature, and maybe an array of mass
fractions. Its return value must be provided in standard SI units of
``Pa\\cdotp{}s``.
Evaluation of the viscosity of a substance.
Its return value must be in ``Pa\\cdotp{}s``.
"""
function viscosity end

0 comments on commit a79003a

Please sign in to comment.