change name to XCALibre and add basic docs deployment

mberto79 · Aug 29, 2024 · ee2e4c8 · ee2e4c8
1 parent 8c31d39
commit ee2e4c8
Show file tree

Hide file tree

Showing 75 changed files with 207 additions and 174 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - main # update to match your development branch (master, main, dev, trunk, ...)
+ - dev-0.3-main
+ tags: '*'
+ pull_request:
+
+jobs:
+ build:
+ permissions:
+ actions: write
+ contents: write
+ pull-requests: read
+ statuses: write
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: julia-actions/setup-julia@v2
+ with:
+ version: '1.10'
+ - uses: julia-actions/cache@v1
+ - name: Install dependencies
+ run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+ - name: Build and deploy
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+ run: julia --project=docs/ docs/make.jl
diff --git a/CASE_3D_BFS U.jl b/CASE_3D_BFS U.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_3D_BFS.jl b/CASE_3D_BFS.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # bfs_unv_tet_15mm, 10mm, 5mm, 4mm, 3mm

diff --git a/CASE_3D_BFS_LES.jl b/CASE_3D_BFS_LES.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_3D_BFS_LES_abhi.jl b/CASE_3D_BFS_LES_abhi.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 using Adapt
 

diff --git a/CASE_3D_BFS_periodic.jl b/CASE_3D_BFS_periodic.jl
@@ -1,4 +1,4 @@
-using FVM_1D
+using XCALibre
 
 mesh_file = "unv_sample_meshes/BFS_UNV_3D_hex_5mm.unv"
 mesh = UNV3D_mesh(mesh_file, scale=0.001)

diff --git a/CASE_3D_BFS_periodic_U.jl b/CASE_3D_BFS_periodic_U.jl
@@ -1,4 +1,4 @@
-using FVM_1D
+using XCALibre
 using CUDA
 using Adapt
 

diff --git a/CASE_3D_box.jl b/CASE_3D_box.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_3D_cascade_periodic.jl b/CASE_3D_cascade_periodic.jl
@@ -1,4 +1,4 @@
-using FVM_1D
+using XCALibre
 using Adapt
 using CUDA
 

diff --git a/CASE_3D_cylinder.jl b/CASE_3D_cylinder.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_3D_cylinder_U.jl b/CASE_3D_cylinder_U.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_MESH2_BFS.jl b/CASE_MESH2_BFS.jl
@@ -1,11 +1,11 @@
 using Plots
 
-using FVM_1D.Mesh2D
-using FVM_1D.Plotting
-using FVM_1D.Discretise
-using FVM_1D.Calculate
-using FVM_1D.Models
-using FVM_1D.Solvers
+using XCALibre.Mesh2D
+using XCALibre.Plotting
+using XCALibre.Discretise
+using XCALibre.Calculate
+using XCALibre.Models
+using XCALibre.Solvers
 
 using Krylov
 

diff --git a/CASE_OF_CRMHL_Wingbody.jl b/CASE_OF_CRMHL_Wingbody.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_OF_buildings.jl b/CASE_OF_buildings.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_OF_pitzdaily.jl b/CASE_OF_pitzdaily.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_OF_sphere_laminar.jl b/CASE_OF_sphere_laminar.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_OF_startrek.jl b/CASE_OF_startrek.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_UNV_BFS.jl b/CASE_UNV_BFS.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm

diff --git a/CASE_UNV_BFS_U.jl b/CASE_UNV_BFS_U.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_UNV_BFS_U_lowRe.jl b/CASE_UNV_BFS_U_lowRe.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm

diff --git a/CASE_UNV_BFS_given_profile.jl b/CASE_UNV_BFS_given_profile.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 using StaticArrays
 

diff --git a/CASE_UNV_BFS_highRe.jl b/CASE_UNV_BFS_highRe.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_UNV_BFS_lowRe.jl b/CASE_UNV_BFS_lowRe.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Krylov
 using KernelAbstractions
 using CUDA

diff --git a/CASE_UNV_BFS_neural_network.jl b/CASE_UNV_BFS_neural_network.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using Flux
 using Statistics
 using LinearAlgebra
@@ -56,9 +56,9 @@ struct Inflow{F,I,O,N,V,B} <: XCALibreUserFunctor
 end
 Adapt.@adapt_structure Inflow
 
-# import FVM_1D.Discretise: update_boundary!
+# import XCALibre.Discretise: update_boundary!
 
-FVM_1D.Discretise.update_user_boundary!(
+XCALibre.Discretise.update_user_boundary!(
  BC::DirichletFunction{I,V}, faces, cells, facesID_range, time, config) where{I,V<:Inflow}= begin
  # if time > 1 # for this to work need to add time to steady solvers! # to do
  # return nothing

diff --git a/CASE_UNV_BFS_transonic.jl b/CASE_UNV_BFS_transonic.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 # using CUDA
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm

diff --git a/CASE_UNV_Cavity.jl b/CASE_UNV_Cavity.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # quad and trig 40 and 100

diff --git a/CASE_UNV_flatplate.jl b/CASE_UNV_flatplate.jl
@@ -1,6 +1,6 @@
 using Plots
 
-using FVM_1D
+using XCALibre
 
 using Krylov
 

diff --git a/CASE_UNV_flatplate_LKE_ERCOFTAC.jl b/CASE_UNV_flatplate_LKE_ERCOFTAC.jl
@@ -1,4 +1,4 @@
-using FVM_1D
+using XCALibre
 using CUDA
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm
@@ -31,49 +31,49 @@ model = Physics(
  )
 
 @assign! model momentum U (
- FVM_1D.Dirichlet(:inlet, velocity),
+ XCALibre.Dirichlet(:inlet, velocity),
  Neumann(:outlet, 0.0),
- FVM_1D.Dirichlet(:wall, [0.0, 0.0, 0.0]),
- FVM_1D.Dirichlet(:bottom, velocity),
+ XCALibre.Dirichlet(:wall, [0.0, 0.0, 0.0]),
+ XCALibre.Dirichlet(:bottom, velocity),
  Neumann(:freestream, 0.0),
 )
 
 @assign! model momentum p (
  Neumann(:inlet, 0.0),
- FVM_1D.Dirichlet(:outlet, 0.0),
+ XCALibre.Dirichlet(:outlet, 0.0),
  Neumann(:wall, 0.0),
  Neumann(:bottom, 0.0),
  Neumann(:freestream, 0.0)
 )
 
 @assign! model turbulence kl (
- FVM_1D.Dirichlet(:inlet, kL_inlet),
+ XCALibre.Dirichlet(:inlet, kL_inlet),
  Neumann(:outlet, 0.0),
- FVM_1D.Dirichlet(:wall, 1e-15),
+ XCALibre.Dirichlet(:wall, 1e-15),
  Neumann(:bottom, 0.0),
  Neumann(:freestream, 0.0)
 )
 
 @assign! model turbulence k (
- FVM_1D.Dirichlet(:inlet, k_inlet),
+ XCALibre.Dirichlet(:inlet, k_inlet),
  Neumann(:outlet, 0.0),
- FVM_1D.Dirichlet(:wall, 0.0),
+ XCALibre.Dirichlet(:wall, 0.0),
  Neumann(:bottom, 0.0),
  Neumann(:freestream, 0.0)
 )
 
 @assign! model turbulence omega (
- FVM_1D.Dirichlet(:inlet, ω_inlet),
+ XCALibre.Dirichlet(:inlet, ω_inlet),
  Neumann(:outlet, 0.0),
  OmegaWallFunction(:wall),
  Neumann(:bottom, 0.0),
  Neumann(:freestream, 0.0)
 )
 
 @assign! model turbulence nut (
- FVM_1D.Dirichlet(:inlet, k_inlet/ω_inlet),
+ XCALibre.Dirichlet(:inlet, k_inlet/ω_inlet),
  Neumann(:outlet, 0.0),
- FVM_1D.Dirichlet(:wall, 0.0), 
+ XCALibre.Dirichlet(:wall, 0.0), 
  Neumann(:bottom, 0.0),
  Neumann(:freestream, 0.0),
 )

diff --git a/CASE_UNV_flatplate_fixedT.jl b/CASE_UNV_flatplate_fixedT.jl
@@ -1,6 +1,6 @@
 using Plots
 
-using FVM_1D
+using XCALibre
 
 using Krylov
 

diff --git a/CASE_UNV_flatplate_fixedT_KOmega.jl b/CASE_UNV_flatplate_fixedT_KOmega.jl
@@ -1,6 +1,6 @@
 using Plots
 
-using FVM_1D
+using XCALibre
 
 using Krylov
 

diff --git a/CASE_UNV_flatplate_highRe.jl b/CASE_UNV_flatplate_highRe.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm

diff --git a/CASE_UNV_flatplate_lowRe.jl b/CASE_UNV_flatplate_lowRe.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 
 
 # backwardFacingStep_2mm, backwardFacingStep_10mm

diff --git a/CASE_cylinder.jl b/CASE_cylinder.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA # Run this if using NVIDIA GPU
 # using AMDGPU # Run this if using AMD GPU
 

diff --git a/CASE_cylinder_LES.jl b/CASE_cylinder_LES.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # quad, backwardFacingStep_2mm, backwardFacingStep_10mm, trig40

diff --git a/CASE_cylinder_M09.jl b/CASE_cylinder_M09.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 # using CUDA # Run this if using NVIDIA GPU
 # using AMDGPU # Run this if using AMD GPU
 

diff --git a/CASE_cylinder_RANS.jl b/CASE_cylinder_RANS.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 

diff --git a/CASE_cylinder_U.jl b/CASE_cylinder_U.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 
 # quad, backwardFacingStep_2mm, backwardFacingStep_10mm, trig40

diff --git a/CASE_cylinder_URANS.jl b/CASE_cylinder_URANS.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 
 
 # quad, backwardFacingStep_2mm, backwardFacingStep_10mm, trig40

diff --git a/CASE_cylinder_U_oscilating.jl b/CASE_cylinder_U_oscilating.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 using CUDA
 using StaticArrays
 

diff --git a/CASE_cylinder_heated.jl b/CASE_cylinder_heated.jl
@@ -1,5 +1,5 @@
 using Plots
-using FVM_1D
+using XCALibre
 # using CUDA # Run this if using NVIDIA GPU
 # using AMDGPU # Run this if using AMD GPU
 

diff --git a/CASE_cylinder_heated_unsteady.jl b/CASE_cylinder_heated_unsteady.jl
@@ -1,5 +1,5 @@
 # using Plots
-using FVM_1D
+using XCALibre
 # using CUDA # Run this if using NVIDIA GPU
 # using AMDGPU # Run this if using AMD GPU