Skip to content

Missing Descriptions for Formula Components in haydavies #2183

Closed
@BernatNicolau

Description

@BernatNicolau

The formula components for the haydavies function seems to not be properly defined. The current formula is:

$I_{d} = DHI \left( A R_b + (1 - A) \left(\frac{1 + \cos \beta}{2}\right) \right)$

However, the documentation does not provide definitions or explanations for the components $A$ and $R_b$. While $DHI$ and $\beta$ are relatively straightforward, I feel it would be beneficial to include their descriptions for completeness.

Additionally, isotropic, klutcher and reindl also lack description of formula components.

Request

  1. Update the documentation for the haydavies function to include descriptions for the following components:

    • $A$
    • $R_b$
    • $DHI$
    • $\beta$
  2. Update the documentation for the isotropic, klutcher and reindl (shall different issues be created for each function?)

I think that providing these definitions will improve clarity.

Thank you!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions