HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoolantHeatCondition.html
iamboss d7836db45f update XML IO pattern.
2026-05-24 14:06:51 +08:00

701 lines
25 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class CoolantHeatCondition | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CoolantHeatCondition | HiAPI-C# 2025 ">
<meta name="description" content="Represents the heat condition parameters for coolant in machining operations. Provides effective convection-coefficient lookups keyed by — Flood uses the configured baseline ; Mist scales it by ; Off falls back to (natural/forced air).">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Physics.CoolantHeatCondition">
<h1 id="Hi_Physics_CoolantHeatCondition" data-uid="Hi.Physics.CoolantHeatCondition" class="text-break">
Class CoolantHeatCondition
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Physics.html">Physics</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents the heat condition parameters for coolant in machining operations.
Provides effective convection-coefficient lookups keyed by
<a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a> — Flood uses the configured baseline
<a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K">CoolantConvectionCoefficient_Wdm2K</a>; Mist scales it by
<a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_MistFloodConvectionRatio">MistFloodConvectionRatio</a>; Off falls back to
<a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_OffConvectionCoefficient_Wdm2K">OffConvectionCoefficient_Wdm2K</a> (natural/forced air).</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CoolantHeatCondition : IMakeXmlSource</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">CoolantHeatCondition</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Physics_CoolantHeatCondition__ctor_" data-uid="Hi.Physics.CoolantHeatCondition.#ctor*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition__ctor" data-uid="Hi.Physics.CoolantHeatCondition.#ctor">
CoolantHeatCondition()
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Physics.CoolantHeatCondition.html">CoolantHeatCondition</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CoolantHeatCondition()</code></pre>
</div>
<a id="Hi_Physics_CoolantHeatCondition__ctor_" data-uid="Hi.Physics.CoolantHeatCondition.#ctor*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition__ctor_System_Xml_Linq_XElement_" data-uid="Hi.Physics.CoolantHeatCondition.#ctor(System.Xml.Linq.XElement)">
CoolantHeatCondition(XElement)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Physics.CoolantHeatCondition.html">CoolantHeatCondition</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CoolantHeatCondition(XElement src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>The XML element containing coolant heat condition data.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K_" data-uid="Hi.Physics.CoolantHeatCondition.CoolantConvectionCoefficient_Wdm2K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K" data-uid="Hi.Physics.CoolantHeatCondition.CoolantConvectionCoefficient_Wdm2K">
CoolantConvectionCoefficient_Wdm2K
</h3>
<div class="markdown level1 summary"><p>Gets or sets the coolant heat transfer coefficient (flood baseline)
in Watts per square meter per Kelvin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double CoolantConvectionCoefficient_Wdm2K { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Common value:
forced air: 10~500;
coolant: 1e3~1e4 (ref by &ldquo;Effects of coolant on temperature distribution in metal machining&rdquo;, 1988)
coolant: 1e3 (ref by &ldquo;Modeling heat transfer in die milling&rdquo;, 2014)</p>
</div>
<a id="Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdmm2K_" data-uid="Hi.Physics.CoolantHeatCondition.CoolantConvectionCoefficient_Wdmm2K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdmm2K" data-uid="Hi.Physics.CoolantHeatCondition.CoolantConvectionCoefficient_Wdmm2K">
CoolantConvectionCoefficient_Wdmm2K
</h3>
<div class="markdown level1 summary"><p>Gets or sets the coolant heat transfer coefficient (flood baseline)
in Watts per square millimeter per Kelvin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double CoolantConvectionCoefficient_Wdmm2K { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Physics_CoolantHeatCondition_CoolantTemperature_C_" data-uid="Hi.Physics.CoolantHeatCondition.CoolantTemperature_C*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_CoolantTemperature_C" data-uid="Hi.Physics.CoolantHeatCondition.CoolantTemperature_C">
CoolantTemperature_C
</h3>
<div class="markdown level1 summary"><p>Gets or sets the coolant temperature in Celsius.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double CoolantTemperature_C { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Physics_CoolantHeatCondition_CoolantTemperature_K_" data-uid="Hi.Physics.CoolantHeatCondition.CoolantTemperature_K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_CoolantTemperature_K" data-uid="Hi.Physics.CoolantHeatCondition.CoolantTemperature_K">
CoolantTemperature_K
</h3>
<div class="markdown level1 summary"><p>Gets or sets the coolant temperature in Kelvin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double CoolantTemperature_K { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Physics_CoolantHeatCondition_MistFloodConvectionRatio_" data-uid="Hi.Physics.CoolantHeatCondition.MistFloodConvectionRatio*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_MistFloodConvectionRatio" data-uid="Hi.Physics.CoolantHeatCondition.MistFloodConvectionRatio">
MistFloodConvectionRatio
</h3>
<div class="markdown level1 summary"><p>Convection-coefficient ratio of mist coolant (MQL) relative to flood
coolant. Applied multiplicatively to
<a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K">CoolantConvectionCoefficient_Wdm2K</a> when the current
<a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a> is <a class="xref" href="Hi.Numerical.CoolantMode.html#Hi_Numerical_CoolantMode_Mist">Mist</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double MistFloodConvectionRatio { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Physics_CoolantHeatCondition_MistFloodConvectionRatio_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Default <code>0.5</code>. Industry handbooks place MQL at roughly half the
heat removal of flood coolant — UNIST MQL Handbook: &ldquo;actual heat
removal is generally about half of that removed by a flood coolant&rdquo;.
Empirical milling / turning measurements on AISI 1045 steel give
ΔT_flood ≈ 230 °C vs ΔT_mist ≈ 170 °C relative to dry (Mist ≈ 0.74
of flood), while tool-life / surface-finish studies on aluminium and
titanium range 0.4–0.8. The single-number <code>0.5</code> default is the
conservative midpoint; projects that characterise their own MQL
system should override via XML.</p>
</div>
<a id="Hi_Physics_CoolantHeatCondition_OffConvectionCoefficient_Wdm2K_" data-uid="Hi.Physics.CoolantHeatCondition.OffConvectionCoefficient_Wdm2K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_OffConvectionCoefficient_Wdm2K" data-uid="Hi.Physics.CoolantHeatCondition.OffConvectionCoefficient_Wdm2K">
OffConvectionCoefficient_Wdm2K
</h3>
<div class="markdown level1 summary"><p>Gets or sets the convection coefficient when coolant is off
(ambient air / forced blow-off), in Watts per square meter per Kelvin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double OffConvectionCoefficient_Wdm2K { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Physics_CoolantHeatCondition_OffConvectionCoefficient_Wdm2K_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Natural convection in still air is ~5–25 W/(m²·K); forced air
(shop blow-off / chip conveyor draft) falls in 10–500 W/(m²·K).
Default <code>50</code> W/(m²·K) represents a mild forced-air environment
typical of a running machine enclosure.</p>
</div>
<a id="Hi_Physics_CoolantHeatCondition_XName_" data-uid="Hi.Physics.CoolantHeatCondition.XName*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_XName" data-uid="Hi.Physics.CoolantHeatCondition.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Name for XML IO.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Physics_CoolantHeatCondition_GetEffectiveConvectionCoefficient_Wdm2K_" data-uid="Hi.Physics.CoolantHeatCondition.GetEffectiveConvectionCoefficient_Wdm2K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_GetEffectiveConvectionCoefficient_Wdm2K_Hi_Numerical_CoolantMode_" data-uid="Hi.Physics.CoolantHeatCondition.GetEffectiveConvectionCoefficient_Wdm2K(Hi.Numerical.CoolantMode)">
GetEffectiveConvectionCoefficient_Wdm2K(CoolantMode)
</h3>
<div class="markdown level1 summary"><p>Gets the effective convection coefficient for the given coolant mode
in Watts per square meter per Kelvin.</p>
<ul><li><a class="xref" href="Hi.Numerical.CoolantMode.html#Hi_Numerical_CoolantMode_Flood">Flood</a>: <a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K">CoolantConvectionCoefficient_Wdm2K</a></li><li><a class="xref" href="Hi.Numerical.CoolantMode.html#Hi_Numerical_CoolantMode_Mist">Mist</a>: <a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_CoolantConvectionCoefficient_Wdm2K">CoolantConvectionCoefficient_Wdm2K</a> × <a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_MistFloodConvectionRatio">MistFloodConvectionRatio</a></li><li><a class="xref" href="Hi.Numerical.CoolantMode.html#Hi_Numerical_CoolantMode_Off">Off</a> / <a class="xref" href="Hi.Numerical.CoolantMode.html#Hi_Numerical_CoolantMode_UnDefined">UnDefined</a>: <a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_OffConvectionCoefficient_Wdm2K">OffConvectionCoefficient_Wdm2K</a></li></ul>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetEffectiveConvectionCoefficient_Wdm2K(CoolantMode mode)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mode</code> <a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Physics_CoolantHeatCondition_GetEffectiveConvectionCoefficient_Wdmm2K_" data-uid="Hi.Physics.CoolantHeatCondition.GetEffectiveConvectionCoefficient_Wdmm2K*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_GetEffectiveConvectionCoefficient_Wdmm2K_Hi_Numerical_CoolantMode_" data-uid="Hi.Physics.CoolantHeatCondition.GetEffectiveConvectionCoefficient_Wdmm2K(Hi.Numerical.CoolantMode)">
GetEffectiveConvectionCoefficient_Wdmm2K(CoolantMode)
</h3>
<div class="markdown level1 summary"><p>Mode-dependent convection coefficient in Watts per square
millimetre per Kelvin (direct input to the FEM layer). See
<a class="xref" href="Hi.Physics.CoolantHeatCondition.html#Hi_Physics_CoolantHeatCondition_GetEffectiveConvectionCoefficient_Wdm2K_Hi_Numerical_CoolantMode_">GetEffectiveConvectionCoefficient_Wdm2K(CoolantMode)</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GetEffectiveConvectionCoefficient_Wdmm2K(CoolantMode mode)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mode</code> <a class="xref" href="Hi.Numerical.CoolantMode.html">CoolantMode</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Physics_CoolantHeatCondition_MakeXmlSource_" data-uid="Hi.Physics.CoolantHeatCondition.MakeXmlSource*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Physics.CoolantHeatCondition.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_Physics_CoolantHeatCondition_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
<a id="Hi_Physics_CoolantHeatCondition_Reg_" data-uid="Hi.Physics.CoolantHeatCondition.Reg*"></a>
<h3 id="Hi_Physics_CoolantHeatCondition_Reg_Hi_Common_XmlUtils_XFactory_" data-uid="Hi.Physics.CoolantHeatCondition.Reg(Hi.Common.XmlUtils.XFactory)">
Reg(XFactory)
</h3>
<div class="markdown level1 summary"><p>Registers this type's deserializer with the given <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a>
(or <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Default">Default</a> when <code class="paramref">factory</code> is
<code>null</code>). Idempotent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Reg(XFactory factory = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>factory</code> <a class="xref" href="Hi.Common.XmlUtils.XFactory.html">XFactory</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink