{"id":22059755,"url":"https://github.com/precise-simulation/cfdtool","last_synced_at":"2025-04-06T19:13:28.287Z","repository":{"id":49648385,"uuid":"309041372","full_name":"precise-simulation/cfdtool","owner":"precise-simulation","description":"CFDTool - An easy to use OpenFOAM / SU2 / CFD simulation toolbox","archived":false,"fork":false,"pushed_at":"2025-02-14T05:15:09.000Z","size":622353,"stargazers_count":90,"open_issues_count":0,"forks_count":22,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-30T18:08:55.475Z","etag":null,"topics":["cfd","cfd-simulation","cfd-toolbox","cfdtool-toolbox","computational-fluid-dynamics","fluid-flows","fluid-mechanics","fluid-simulation","gui","matlab","matlab-toolbox","multiphysics","openfoam","openfoam-tutorials","simulation","su2","toolbox"],"latest_commit_sha":null,"homepage":"https://www.cfdtool.com","language":"MATLAB","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/precise-simulation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-01T07:01:44.000Z","updated_at":"2025-03-06T11:19:19.000Z","dependencies_parsed_at":"2023-09-26T11:02:07.934Z","dependency_job_id":"f7bcffd3-4f36-4cb7-9a3d-6e2e7945926d","html_url":"https://github.com/precise-simulation/cfdtool","commit_stats":{"total_commits":1,"total_committers":1,"mean_commits":1.0,"dds":0.0,"last_synced_commit":"fa8aeb02312202de9e69541c10abf86f3149ca75"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precise-simulation%2Fcfdtool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precise-simulation%2Fcfdtool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precise-simulation%2Fcfdtool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precise-simulation%2Fcfdtool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/precise-simulation","download_url":"https://codeload.github.com/precise-simulation/cfdtool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247535520,"owners_count":20954576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cfd","cfd-simulation","cfd-toolbox","cfdtool-toolbox","computational-fluid-dynamics","fluid-flows","fluid-mechanics","fluid-simulation","gui","matlab","matlab-toolbox","multiphysics","openfoam","openfoam-tutorials","simulation","su2","toolbox"],"created_at":"2024-11-30T17:32:11.993Z","updated_at":"2025-04-06T19:13:28.257Z","avatar_url":"https://github.com/precise-simulation.png","language":"MATLAB","funding_links":[],"categories":[],"sub_categories":[],"readme":"CFDTool - _CFD Simulation Made Easy_\n====================================\n\n![CFDTool Screenshot](screenshot.jpg)\n\nAbout\n-----\n\n[**CFDTool**](https://www.cfdtool.com) is a\n[\u003cb\u003eC\u003c/b\u003eomputational \u003cb\u003eF\u003c/b\u003eluid \u003cb\u003eD\u003c/b\u003eynamics (CFD)](https://en.wikipedia.org/wiki/Computational_fluid_dynamics)\n\u003cb\u003eTool\u003c/b\u003ebox for modeling and simulation of fluid flows with coupled\nheat transfer.\n\nBased on the [FEATool Multiphysics](https://www.featool.com)\nsimulation platform, _CFDTool_ is specifically designed to make fluid\ndynamics and heat transfer simulations easy and fun.\n\n\nFeatures\n--------\n\nThe _CFDTool_ toolbox includes the following features:\n\n- Completely stand-alone and self-contained toolbox\n- Fully integrated and easy to use Graphical User Interface (GUI)\n- Modeling and simulation in 1D, 2D, 3D, and axisymmetric coordinate systems\n- Seamless [OpenFOAM GUI](https://www.featool.com/Easy-to-Use-OpenFOAM-GUI/) and\n  [SU2](https://www.featool.com/doc/su2.html) CFD solver integrations\n- Built-in geometry and CAD tools\n- Automatic mesh and grid generation\n- Pre-defined equations and boundary conditions:\n  + Incompressible viscous fluid flows (Navier-Stokes equations)\n  + Compressible inviscid flows (Euler equations)\n  + Heat transfer (Convection and Conduction)\n- Multiphysics support for fluid flow and thermal analysis\n- Simulation of laminar and turbulent flows (Spalart-Allmaras,\n  k-epsilon, and k-omega turbulence models available with OpenFOAM/SU2)\n- Stationary and time-dependent analysis types\n- Postprocessing and visualization\n\n\n[System Requirements](https://www.featool.com/doc/quickstart.html#prereq)\n-------------------\n\n_CFDTool_ is a fully integrated simulation environment, which has been\ntested and verified to work with 64-bit Windows, Linux, and MacOS\noperating systems with a minimum of 4 GB RAM memory.\n\n\n[Installation](https://www.featool.com/doc/quickstart.html#install)\n------------\n\nIn order to use _CFDTool_, the software must first be installed on the\nintended computer system. It is recommended to first uninstall\nprevious versions before installing/upgrading to a newer version.\n\nPlease follow the steps below to install _CFDTool_ as a stand-alone\napp, or as a MATLAB® toolbox. The installers can be downloaded\ndirectly from the\n[CFDTool releases](https://github.com/precise-simulation/cfdtool/releases/latest)\nand installed manually, or installed from the MATLAB® APPS and Add-On\nToolbar as a toolbox.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.cfdtool.com/download\" target=\"_blank\"\u003e\n    \u003cimg src=\"download.png\" alt=\"CFDTool Download\" style=\"max-width:50%\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n### Stand-Alone App Installation\n\nUse the steps below to install the app in stand-alone mode\n\n1) First download the installer for your operating system\n\n    + [**CFDTool Windows Installer**](https://github.com/precise-simulation/cfdtool/releases/latest/download/CFDTool_install.exe)\n\n    + [**CFDTool Linux Installer**](https://github.com/precise-simulation/cfdtool/releases/latest/download/CFDTool.install)\n\n2) Save it to a directory and run the installer. This will first\ndownload and/or install the application runtime if required (which may\nrequire up to 10 GB space to install), and then the program file will\nbe extracted.\n\n3) When everything has been installed, run the program file to start\n_CFDTool_. Please be patient as the application runtime can take some\ntime to start.\n\n\n### MATLAB® Toolbox Installation\n\nFollow the steps below to install _FEATool_ as a MATLAB® toolbox, and\nto enable running MATLAB® simulation m-scripts\n\n1) Download the\n   [CFDTool.mlappinstall](https://github.com/precise-simulation/cfdtool/releases/latest/download/CFDTool.mlappinstall)\n   toolbox installation file.\n\n2) Then start MATLAB®, press the **APPS** toolbar button,\n   and select the **Install App** button.\n\n3) When prompted to choose a toolbox file to install, select the\n   **CFDTool.mlappinstall** file and press **OK**.\n\n4) Press the **Install** button if prompted to _\"Install to My Apps\"_.\n\n![CFDTool MATLAB® Toolbox Installation](https://www.featool.com/doc/featool-multiphysics-toolbox-installation_50.jpg)\n\nOnce the toolbox has been installed, an app icon will be available in\nthe _APPS_ toolbar to start the _CFDTool_ GUI. (Note that MATLAB® may\nnot show or give any indication of the toolbox installation progress\nor completion.)\n\n\n[OpenFOAM® CFD Solver](https://featool.com/doc/openfoam.html)\n--------------------\n\nThe optional OpenFOAM CFD solver integration makes it easy to perform\nboth laminar and turbulent high performance CFD simulations. OpenFOAM\nCFD simulations often results in a magnitude or more speedup for\ninstationary simulations compared to the built-in flow\nsolvers. Additionally, with the multi-simulation solver integration in\n_CFDTool_ it is possible to compare and better validate simulation\nresults obtained using both the built-in and OpenFOAM CFD solvers.\n\nThe OpenFOAM solver binaries are currently not included with _CFDTool_\nand must be installed separately. The OpenFOAM solver integration has\nbeen verified with OpenFOAM versions 2021 and 9. For Microsoft Windows\nsystems it is recommended to install and use the pre-compiled\nNative-windows/mingw binaries available from\n[OpenCFD ESI](https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/windows),\nor the distribution from the\n[OpenFOAM Foundation](https://openfoam.org/download)\nfor Linux and MacOS systems.\n\n\nBasic Use\n---------\n\n_CFDTool_ and its GUI has been specifically designed to be as easy to\nuse as possible, and making learning CFD simulation by experimentation\neasy.\n\nThe modeling process is divided into six different steps or modes\n\n- **Geometry** - Definition of the geometry to be modeled\n- **Grid** - Subdivision of the geometry into smaller cells suitable\n  for computation\n- **Equation** - Specification of material parameters and coefficients\n- **Boundary** - Boundary conditions specify how the model interacts\n  with the surrounding environment (outside the geometry)\n- **Solve** - Solution and simulation of the defined model problem\n- **Post** - Visualization and postprocessing\n\nThese modes can be accessed by clicking on the corresponding buttons\nin left hand side _Mode_ toolbar. The different modes may have\nspecialized and different _Tools_ available in the corresponding\ntoolbar. Advanced mode options may also be available in the\ncorresponding menus.\n\nA number of pre-defined fluid flow and heat transfer tutorial examples\nare available under the **File** \u003e **Model Examples and Tutorials...**\nmenu option.\n\nBasic use and how to set up and model turbulent flow past a\nbackwards facing step with OpenFOAM is explained in the\n[linked video tutorial](https://youtu.be/gHGttc31xj0)\n(click on the image below to start the tutorial).\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.youtube.com/watch?v=gHGttc31xj0\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.youtube.com/vi/gHGttc31xj0/0.jpg\"\n         alt=\"CFDTool \u0026 OpenFOAM GUI Video Tutorial\" style=\"max-width:100%\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\nDocumentation\n-------------\n\nThe _FEATool_\n[documentation](https://www.featool.com/doc),\nwhich shares most functionality with _CFDTool_, is available online,\nand also by selecting the corresponding option in the _Help_ menu of\nthe _CFDTool_ GUI.\n\n\nLicense\n-------\n\n(C) Copyright 2013-2025 by Precise Simulation Limited.\nAll Rights Reserved.\n\nCFDTool™ and FEATool Multiphysics™ are trademarks of Precise\nSimulation Limited. MATLAB® is a registered trademark of The\nMathWorks, Inc.  OPENFOAM® is a registered trade mark of OpenCFD\nLimited. All other trademarks are the property of their respective\nowners. Precise Simulation Ltd and its products are not affiliated\nwith, endorsed by, sponsored by these trademark owners.\n\nThe license agreement for using CFDTool™ is included with the\ndistribution and can also be accessed from the _Help_ menu in the\napplication.\n\nCarefully read the license terms and conditions before installing or\nusing the programs or documentation. Installing or using the programs\nmeans you have accepted and agree to be bound by the terms and\nconditions of this agreement. if you do not accept them, uninstall,\nremove and completely delete the programs and documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecise-simulation%2Fcfdtool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprecise-simulation%2Fcfdtool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecise-simulation%2Fcfdtool/lists"}