Skip to content

Added design result methods #3585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MariaGlimaker wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Added design result methods #3585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions Structure_Engine/Query/EvaluateResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
*
*
* The BHoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3.0 of the License, or
* (at your option) any later version.
*
* The BHoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
*/

using System.ComponentModel;
using BH.oM.Base.Attributes;
using BH.oM.Structure.Results;

namespace BH.Engine.Structure
{
public static partial class Query
{
/***************************************************/
/**** Public Methods ****/
/***************************************************/

[Description("Evaluates the design result by comparing Action and Resistance.")]
[Input("result", "The DesignResult containing Action, Resistance, RequiredFactorOfSafety, and CheckType used to evaluate the design condition.")]
[Output("Evaluation", "Returns \"Pass\" if the design satisfies the check condition, otherwise \"Fail\".")]
public static string EvaluateResult(this DesignResult result)
{
if (result == null || result.FactorOfSafetyUtilisation() == double.NaN)
{
Base.Compute.RecordError("Design result or factor of safety utilisation is null or invalid.");
return null;
}
return result.FactorOfSafetyUtilisation() <= 1.0 ? "Pass" : "Fail";
}
/***************************************************/
}
}

57 changes: 57 additions & 0 deletions Structure_Engine/Query/FactorOfSafety.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
*
*
* The BHoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3.0 of the License, or
* (at your option) any later version.
*
* The BHoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
*/

using System;
using System.ComponentModel;
using BH.oM.Base.Attributes;
using BH.oM.Quantities.Attributes;
using BH.oM.Structure.Results;

namespace BH.Engine.Structure
{
public static partial class Query
{
/***************************************************/
/**** Public Methods ****/
/***************************************************/

[Description("The achieved factor of safety, calculated as Resistance divided by Action. A value greater than or equal to RequiredFactorOfSafety indicates a satisfactory design.")]
[Input("result", "DesignResult containing resistance and action.")]
[Output("FactorOfSafety", "The achieved factor of safety.", typeof(Ratio))]
public static double FactorOfSafety(this DesignResult result)
{
if (result == null || result.Resistance == double.NaN || result.Action == double.NaN)
{
Base.Compute.RecordError("Design result information is null or invalid.");
return double.NaN;
}
if (result.Action == 0.0)
{
Base.Compute.RecordError("Action is zero, cannot calculate factor of safety for this design result.");
return double.NaN;
}
return Math.Abs(result.Resistance / result.Action);
}
/***************************************************/
}
}

56 changes: 56 additions & 0 deletions Structure_Engine/Query/FactorOfSafetyUtilisation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
*
*
* The BHoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3.0 of the License, or
* (at your option) any later version.
*
* The BHoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
*/

using System.ComponentModel;
using BH.oM.Base.Attributes;
using BH.oM.Quantities.Attributes;
using BH.oM.Structure.Results;

namespace BH.Engine.Structure
{
public static partial class Query
{
/***************************************************/
/**** Public Methods ****/
/***************************************************/

[Description("The utilisation of the factor of safety, calculated as RequiredFactorOfSafety divided by FactorOfSafety. A value less than or equal to 1.0 indicates a satisfactory design.")]
[Input("result", "DesignResult containing resistance, action and required factor of safety.")]
[Output("FactorOfSafetyUtilization", "The utilisation of the factor of safety.", typeof(Ratio))]
public static double FactorOfSafetyUtilisation(this DesignResult result)
{
if (result == null || result.RequiredFactorOfSafety == double.NaN || result.FactorOfSafety() == double.NaN)
{
Base.Compute.RecordError("Design result information is null or invalid.");
return double.NaN;
}
if (result.FactorOfSafety() == 0.0)
{
Base.Compute.RecordError("Factor of safety is zero, cannot calculate factor of safety utilisation for this design result.");
return double.NaN;
}
return result.RequiredFactorOfSafety / result.FactorOfSafety();
}
/***************************************************/
}
}