Skip to content
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.

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

Creating pull request for 10.21105.joss.05565 #4424

Merged
merged 5 commits into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
150 changes: 150 additions & 0 deletions joss.05565/10.21105.joss.05565.crossref.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
<?xml version="1.0" encoding="UTF-8"?>
<doi_batch xmlns="http://www.crossref.org/schema/5.3.1"
xmlns:ai="http://www.crossref.org/AccessIndicators.xsd"
xmlns:rel="http://www.crossref.org/relations.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.3.1"
xsi:schemaLocation="http://www.crossref.org/schema/5.3.1 http://www.crossref.org/schemas/crossref5.3.1.xsd">
<head>
<doi_batch_id>20230721T214704-19a31f3baf12b5b45a8ef8c2f2df0586bad718fb</doi_batch_id>
<timestamp>20230721214704</timestamp>
<depositor>
<depositor_name>JOSS Admin</depositor_name>
<email_address>admin@theoj.org</email_address>
</depositor>
<registrant>The Open Journal</registrant>
</head>
<body>
<journal>
<journal_metadata>
<full_title>Journal of Open Source Software</full_title>
<abbrev_title>JOSS</abbrev_title>
<issn media_type="electronic">2475-9066</issn>
<doi_data>
<doi>10.21105/joss</doi>
<resource>https://joss.theoj.org/</resource>
</doi_data>
</journal_metadata>
<journal_issue>
<publication_date media_type="online">
<month>07</month>
<year>2023</year>
</publication_date>
<journal_volume>
<volume>8</volume>
</journal_volume>
<issue>87</issue>
</journal_issue>
<journal_article publication_type="full_text">
<titles>
<title>SyntheticEddyMethod.jl: A Julia package for the
creation of inlet flow conditions for LES</title>
</titles>
<contributors>
<person_name sequence="first" contributor_role="author">
<given_name>Carlo</given_name>
<surname>Brunelli</surname>
<ORCID>https://orcid.org/0000-0002-2873-6293</ORCID>
</person_name>
</contributors>
<publication_date>
<month>07</month>
<day>21</day>
<year>2023</year>
</publication_date>
<pages>
<first_page>5565</first_page>
</pages>
<publisher_item>
<identifier id_type="doi">10.21105/joss.05565</identifier>
</publisher_item>
<ai:program name="AccessIndicators">
<ai:license_ref applies_to="vor">http://creativecommons.org/licenses/by/4.0/</ai:license_ref>
<ai:license_ref applies_to="am">http://creativecommons.org/licenses/by/4.0/</ai:license_ref>
<ai:license_ref applies_to="tdm">http://creativecommons.org/licenses/by/4.0/</ai:license_ref>
</ai:program>
<rel:program>
<rel:related_item>
<rel:description>Software archive</rel:description>
<rel:inter_work_relation relationship-type="references" identifier-type="doi">10.5281/zenodo.8167205</rel:inter_work_relation>
</rel:related_item>
<rel:related_item>
<rel:description>GitHub review issue</rel:description>
<rel:inter_work_relation relationship-type="hasReview" identifier-type="uri">https://github.com/openjournals/joss-reviews/issues/5565</rel:inter_work_relation>
</rel:related_item>
</rel:program>
<doi_data>
<doi>10.21105/joss.05565</doi>
<resource>https://joss.theoj.org/papers/10.21105/joss.05565</resource>
<collection property="text-mining">
<item>
<resource mime_type="application/pdf">https://joss.theoj.org/papers/10.21105/joss.05565.pdf</resource>
</item>
</collection>
</doi_data>
<citation_list>
<citation key="Bezanson:2017">
<article_title>Julia: A fresh approach to numerical
computing</article_title>
<author>Bezanson</author>
<journal_title>SIAM review</journal_title>
<issue>1</issue>
<volume>59</volume>
<doi>10.1137/141000671</doi>
<cYear>2017</cYear>
<unstructured_citation>Bezanson, J., Edelman, A., Karpinski,
S., &amp; Shah, V. B. (2017). Julia: A fresh approach to numerical
computing. SIAM Review, 59(1), 65–98.
https://doi.org/10.1137/141000671</unstructured_citation>
</citation>
<citation key="Jarrin:2006">
<article_title>A synthetic-eddy-method for generating inflow
conditions for large-eddy simulations</article_title>
<author>Jarrin</author>
<journal_title>International Journal of Heat and Fluid
Flow</journal_title>
<volume>27</volume>
<doi>10.1016/j.ijheatfluidflow.2006.02.006</doi>
<cYear>2006</cYear>
<unstructured_citation>Jarrin, N., Benhamadouche, S.,
Laurence, D., &amp; Prosser, R. (2006). A synthetic-eddy-method for
generating inflow conditions for large-eddy simulations. International
Journal of Heat and Fluid Flow, 27, 585–593.
https://doi.org/10.1016/j.ijheatfluidflow.2006.02.006</unstructured_citation>
</citation>
<citation key="Poletto:2013">
<article_title>A new divergence free synthetic eddy method
for the reproduction of inlet flow conditions for les</article_title>
<author>Poletto</author>
<journal_title>Flow, Turbulence and
Combustion</journal_title>
<volume>91</volume>
<doi>10.1007/s10494-013-9488-2</doi>
<cYear>2013</cYear>
<unstructured_citation>Poletto, R., Craft, T., &amp; Revell,
A. (2013). A new divergence free synthetic eddy method for the
reproduction of inlet flow conditions for les. Flow, Turbulence and
Combustion, 91, 519–539.
https://doi.org/10.1007/s10494-013-9488-2</unstructured_citation>
</citation>
<citation key="OH:2019">
<article_title>Extended synthetic eddy method to generate
inflow data for turbulent thermal boundary layer</article_title>
<author>Oh</author>
<journal_title>International Journal of Heat and Mass
Transfer</journal_title>
<volume>134</volume>
<doi>10.1016/j.ijheatmasstransfer.2019.02.061</doi>
<issn>0017-9310</issn>
<cYear>2019</cYear>
<unstructured_citation>Oh, G., Noh, K. M., Park, H., &amp;
Choi, J.-I. (2019). Extended synthetic eddy method to generate inflow
data for turbulent thermal boundary layer. International Journal of Heat
and Mass Transfer, 134, 1261–1267.
https://doi.org/10.1016/j.ijheatmasstransfer.2019.02.061</unstructured_citation>
</citation>
</citation_list>
</journal_article>
</journal>
</body>
</doi_batch>
248 changes: 248 additions & 0 deletions joss.05565/10.21105.joss.05565.jats
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Publishing DTD v1.2 20190208//EN"
"JATS-publishing1.dtd">
<article xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" dtd-version="1.2" article-type="other">
<front>
<journal-meta>
<journal-id></journal-id>
<journal-title-group>
<journal-title>Journal of Open Source Software</journal-title>
<abbrev-journal-title>JOSS</abbrev-journal-title>
</journal-title-group>
<issn publication-format="electronic">2475-9066</issn>
<publisher>
<publisher-name>Open Journals</publisher-name>
</publisher>
</journal-meta>
<article-meta>
<article-id pub-id-type="publisher-id">5565</article-id>
<article-id pub-id-type="doi">10.21105/joss.05565</article-id>
<title-group>
<article-title>SyntheticEddyMethod.jl: A Julia package for the creation
of inlet flow conditions for LES</article-title>
</title-group>
<contrib-group>
<contrib contrib-type="author">
<contrib-id contrib-id-type="orcid">https://orcid.org/0000-0002-2873-6293</contrib-id>
<name>
<surname>Brunelli</surname>
<given-names>Carlo</given-names>
</name>
<xref ref-type="aff" rid="aff-1"/>
</contrib>
<aff id="aff-1">
<institution-wrap>
<institution>Mechanical Engineering Department, Royal Military Academy,
Belgium</institution>
</institution-wrap>
</aff>
</contrib-group>
<pub-date date-type="pub" publication-format="electronic" iso-8601-date="2023-04-25">
<day>25</day>
<month>4</month>
<year>2023</year>
</pub-date>
<volume>8</volume>
<issue>87</issue>
<fpage>5565</fpage>
<permissions>
<copyright-statement>Authors of papers retain copyright and release the
work under a Creative Commons Attribution 4.0 International License (CC
BY 4.0)</copyright-statement>
<copyright-year>2022</copyright-year>
<copyright-holder>The article authors</copyright-holder>
<license license-type="open-access" xlink:href="https://creativecommons.org/licenses/by/4.0/">
<license-p>Authors of papers retain copyright and release the work under
a Creative Commons Attribution 4.0 International License (CC BY
4.0)</license-p>
</license>
</permissions>
<kwd-group kwd-group-type="author">
<kwd>Julia</kwd>
<kwd>Turbulence</kwd>
<kwd>Eddy</kwd>
<kwd>Inlet Conditions</kwd>
<kwd>LES</kwd>
</kwd-group>
</article-meta>
</front>
<body>
<sec id="summary">
<title>Summary</title>
<p>The Synthetic Eddy Method (SEM) is a numerical simulation technique
used to create a turbulent flow field with desired features. It is
used in computational fluid dynamics for imposing realistic inlet
boundary conditions, improving the fidelity of the results obtained by
simulations. Its ability to create fluctuations with prescribed
physical features makes it a valuable tool for researchers and
engineers seeking to improve the reliability of simulations and also
for re-creating as much as possible an environment close to an
experimental one. The package allows users to easily generate
synthetic turbulence fields that can be used in CFD simulations, and
to control the level of turbulence and length-scales of the eddies in
the generated fields.</p>
</sec>
<sec id="statement-of-need">
<title>Statement of need</title>
<p><monospace>SyntheticEddyMethod.jl</monospace> is a package which
aims to create realistic turbulent inlet conditions for Large Eddy
Simulations. This package will be a valuable tool for researchers and
engineers working in the field of Computational Fluid Dynamics,
offering an intuitive and efficient way to simulate proper boundary
conditions. The fluctuations generated are more realistic than those
that can be easily produced by a random signal.</p>
<p>The method has been originally introduced by Jarrin et al.
(<xref alt="2006" rid="ref-JarrinU003A2006" ref-type="bibr">2006</xref>).
It is based on the idea of eddies randomly created inside a virtual
box, where no dissipative effects occur. These are convected at every
time-step. Each eddy influences its surroundings based on its
dimension and the chosen kernel (or shape) function. It has been
extended by Poletto et al.
(<xref alt="2013" rid="ref-PolettoU003A2013" ref-type="bibr">2013</xref>),
implementing the divergence-free (DFSEM) constraint to obtain
fluctuations for incompressible flows, which are the most common cases
studied for turbulence.</p>
<p><monospace>SyntheticEddyMethod.jl</monospace> is completely
implemented in the Julia programming language
(<xref alt="Bezanson et al., 2017" rid="ref-BezansonU003A2017" ref-type="bibr">Bezanson
et al., 2017</xref>). In recent years, Julia has emerged as a powerful
language for scientific computing and has become popular among
researchers and practitioners in the field of fluid dynamics. Julia is
extremely expressive and allows one to condense complex mathematical
expressions into a few syntactic lines. The functions are written
almost identically as on paper. This also has an advantage for people
who desire to contribute and use it. By taking advantage of the
flexibility of Julia’s multiple dispatch, it allows users to simulate
fluctuations at specific points in the flow field or at multiple
points simultaneously, offering a powerful optimized tool. Users can
customize several key parameters of the SEM method, such as the
turbulence intensity, Reynolds stress, and eddy dimensions. These
parameters can be set by the user directly, or loaded from a file,
making the package versatile and user-friendly.</p>
<p>Different software packages have been developed to implement this
method (for example, using Fortran, Oh et al.
(<xref alt="2019" rid="ref-OHU003A2019" ref-type="bibr">2019</xref>)).
However, these packages are often limited in their applicability and
can be challenging for non-experts to use.
<monospace>SyntheticEddyMethod.jl</monospace> is designed to be more
general-purpose, allowing it to be applied to a broader range of
turbulence simulation problems. It is designed to be more accessible
and with clear documentation.</p>
<sec id="results">
<title>Results</title>
<fig>
<caption><p>Spectra examples at different Turbulent Intensities
using tent function as shape function. It refers to the
fluctuations in time in one specific point.</p></caption>
<graphic mimetype="image" mime-subtype="png" xlink:href="media/images/docs/Spectra.png" />
</fig>
<fig>
<caption><p>Normalized divergence in a plane using the
divergence-free feature.
<styled-content id="figU003Adfsem-plane"></styled-content></p></caption>
<graphic mimetype="image" mime-subtype="png" xlink:href="media/images/docs/Div_free_plane.png" />
</fig>
</sec>
</sec>
<sec id="package-features">
<title>Package Features</title>
<list list-type="bullet">
<list-item>
<p>Create velocity fluctuations for inlet boundary conditions</p>
</list-item>
<list-item>
<p>Create fluctuations that respect the divergence-free condition
(DFSEM)</p>
</list-item>
<list-item>
<p>Create coherent eddies in a 3D domain</p>
</list-item>
<list-item>
<p>It can simulate anisotropic effects by allowing the eddies to
have different dimensions along different directions</p>
</list-item>
<list-item>
<p>Define a custom Reynolds Stress Tensor</p>
</list-item>
<list-item>
<p>Import custom Reynolds Stress Tensor</p>
</list-item>
</list>
</sec>
</body>
<back>
<ref-list>
<ref id="ref-BezansonU003A2017">
<element-citation publication-type="article-journal">
<person-group person-group-type="author">
<name><surname>Bezanson</surname><given-names>Jeff</given-names></name>
<name><surname>Edelman</surname><given-names>Alan</given-names></name>
<name><surname>Karpinski</surname><given-names>Stefan</given-names></name>
<name><surname>Shah</surname><given-names>Viral B</given-names></name>
</person-group>
<article-title>Julia: A fresh approach to numerical computing</article-title>
<source>SIAM review</source>
<publisher-name>SIAM</publisher-name>
<year iso-8601-date="2017">2017</year>
<volume>59</volume>
<issue>1</issue>
<pub-id pub-id-type="doi">10.1137/141000671</pub-id>
<fpage>65</fpage>
<lpage>98</lpage>
</element-citation>
</ref>
<ref id="ref-JarrinU003A2006">
<element-citation publication-type="article-journal">
<person-group person-group-type="author">
<name><surname>Jarrin</surname><given-names>N.</given-names></name>
<name><surname>Benhamadouche</surname><given-names>S.</given-names></name>
<name><surname>Laurence</surname><given-names>D.</given-names></name>
<name><surname>Prosser</surname><given-names>R.</given-names></name>
</person-group>
<article-title>A synthetic-eddy-method for generating inflow conditions for large-eddy simulations</article-title>
<source>International Journal of Heat and Fluid Flow</source>
<year iso-8601-date="2006-08">2006</year><month>08</month>
<volume>27</volume>
<pub-id pub-id-type="doi">10.1016/j.ijheatfluidflow.2006.02.006</pub-id>
<fpage>585</fpage>
<lpage>593</lpage>
</element-citation>
</ref>
<ref id="ref-PolettoU003A2013">
<element-citation publication-type="paper-conference">
<person-group person-group-type="author">
<name><surname>Poletto</surname><given-names>R.</given-names></name>
<name><surname>Craft</surname><given-names>T.</given-names></name>
<name><surname>Revell</surname><given-names>A.</given-names></name>
</person-group>
<article-title>A new divergence free synthetic eddy method for the reproduction of inlet flow conditions for les</article-title>
<source>Flow, Turbulence and Combustion</source>
<year iso-8601-date="2013-10">2013</year><month>10</month>
<volume>91</volume>
<pub-id pub-id-type="doi">10.1007/s10494-013-9488-2</pub-id>
<fpage>519</fpage>
<lpage>539</lpage>
</element-citation>
</ref>
<ref id="ref-OHU003A2019">
<element-citation publication-type="article-journal">
<person-group person-group-type="author">
<name><surname>Oh</surname><given-names>Geunwoo</given-names></name>
<name><surname>Noh</surname><given-names>Kyung Min</given-names></name>
<name><surname>Park</surname><given-names>Hyunwook</given-names></name>
<name><surname>Choi</surname><given-names>Jung-Il</given-names></name>
</person-group>
<article-title>Extended synthetic eddy method to generate inflow data for turbulent thermal boundary layer</article-title>
<source>International Journal of Heat and Mass Transfer</source>
<year iso-8601-date="2019">2019</year>
<volume>134</volume>
<issn>0017-9310</issn>
<uri>https://www.sciencedirect.com/science/article/pii/S0017931018332289</uri>
<pub-id pub-id-type="doi">10.1016/j.ijheatmasstransfer.2019.02.061</pub-id>
<fpage>1261</fpage>
<lpage>1267</lpage>
</element-citation>
</ref>
</ref-list>
</back>
</article>
Binary file added joss.05565/10.21105.joss.05565.pdf
Binary file not shown.
Binary file added joss.05565/media/images/docs/Div_free_plane.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added joss.05565/media/images/docs/Spectra.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.