diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 5163c36..bccfc9b 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-10-14T13:07:26","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-10-15T07:16:48","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index edfce08..d6bb5ca 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,2 +1,2 @@ -API · GeMotion.jl

Developer Documentation

API

GeMotion.simulate — Method
simulate(;name="sim",Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=["leftline","rightline","botleftpoint","botrightpoint","topleftpoint","toprightpoint"],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])

Simulate the flow in a square cavity with a moving lid and a temperature gradient.

Arguments

  • name::String: Name of the simulation.
  • Pr::Float64: Prandtl number.
  • Ra::Float64: Rayleigh number.
  • n::Float64: Power of the viscosity.
  • n_elems::Int: Number of elements in each direction.
  • nlsolver_opts::Dict: Options for the nonlinear solver.
  • levels::Dict: Levels for the contour plots.
  • T_diri_tags::Array{String}: Tags for the Dirichlet boundary conditions for the temperature.
  • T_diri_expressions::Array{Float64}: Expressions for the Dirichlet boundary conditions for the temperature.

Returns

  • uh::FEFunction: Velocity field.
  • ph::FEFunction: Pressure field.
  • Th::FEFunction: Temperature field.
  • psih::FEFunction: Stream function.
  • Nu::Interpolable: Nusselt number.
  • Sth::FEFunction: Local heat entropy.
  • Sfl::FEFunction: Local fluid entropy.
  • btrian::BoundaryTriangulation: Boundary triangulation.
  • model::CartesianDiscreteModel: Model.
  • Ωₕ::Triangulation: Triangulation.
  • Pr::Float64: Prandtl number.
  • Ra::Float64: Rayleigh number.

Example

simulate(;name="sim",Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=["leftline","rightline","botleftpoint","botrightpoint","topleftpoint","toprightpoint"],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])

Index

+API · GeMotion.jl

Developer Documentation

API

GeMotion.simulate — Method
simulate(;name="sim",Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=["leftline","rightline","botleftpoint","botrightpoint","topleftpoint","toprightpoint"],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])

Simulate the flow in a square cavity with a moving lid and a temperature gradient.

Arguments

  • name::String: Name of the simulation.
  • Pr::Float64: Prandtl number.
  • Ra::Float64: Rayleigh number.
  • n::Float64: Power of the viscosity.
  • n_elems::Int: Number of elements in each direction.
  • nlsolver_opts::Dict: Options for the nonlinear solver.
  • levels::Dict: Levels for the contour plots.
  • T_diri_tags::Array{String}: Tags for the Dirichlet boundary conditions for the temperature.
  • T_diri_expressions::Array{Float64}: Expressions for the Dirichlet boundary conditions for the temperature.

Returns

  • uh::FEFunction: Velocity field.
  • ph::FEFunction: Pressure field.
  • Th::FEFunction: Temperature field.
  • psih::FEFunction: Stream function.
  • Nu::Interpolable: Nusselt number.
  • Sth::FEFunction: Local heat entropy.
  • Sfl::FEFunction: Local fluid entropy.
  • btrian::BoundaryTriangulation: Boundary triangulation.
  • model::CartesianDiscreteModel: Model.
  • Ωₕ::Triangulation: Triangulation.
  • Pr::Float64: Prandtl number.
  • Ra::Float64: Rayleigh number.

Example

simulate(;name="sim",Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=["leftline","rightline","botleftpoint","botrightpoint","topleftpoint","toprightpoint"],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])

Index

diff --git a/dev/index.html b/dev/index.html index 320eb69..249e7c3 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,4 +1,4 @@ -Home · GeMotion.jl

GeMotion.jl: A Navier-Stokes-Fourier Solver for generalized material laws

  • Different material laws, including:
    • Newtonian fluids: $\boldsymbol{\sigma} = \boldsymbol{D}(\boldsymbol{u}) = \frac12 (\boldsymbol{\nabla} \boldsymbol{u} + \boldsymbol{\nabla} \boldsymbol{u}^T)$
    • Non-Newtonian fluids with power-law: $\boldsymbol{\sigma} = K {\left(2 \boldsymbol{D} \boldsymbol{\colon} \boldsymbol{D} \right)}^{\frac{1-n}{2}} \boldsymbol{D}(\boldsymbol{u})$
  • Discretization using Finite Elements in Gridap.jl
  • Solve nonlinear systems using Newtons method

Installation

  • Clone the repository and open the folder
git clone git@github.com:lamBOOO/GeMotion.jl.git
+Home · GeMotion.jl
GeMotion.jl: A Navier-Stokes-Fourier Solver for generalized material laws
  • Different material laws, including:
    • Newtonian fluids: $\boldsymbol{\sigma} = \boldsymbol{D}(\boldsymbol{u}) = \frac12 (\boldsymbol{\nabla} \boldsymbol{u} + \boldsymbol{\nabla} \boldsymbol{u}^T)$
    • Non-Newtonian fluids with power-law: $\boldsymbol{\sigma} = K {\left(2 \boldsymbol{D} \boldsymbol{\colon}  \boldsymbol{D} \right)}^{\frac{1-n}{2}} \boldsymbol{D}(\boldsymbol{u})$
  • Discretization using Finite Elements in Gridap.jl
  • Solve nonlinear systems using Newtons method
Installation
  • Clone the repository and open its folder
git clone git@github.com:lamBOOO/GeMotion.jl.git
 cd GeMotion.jl
  • Install all Julia dependencies
julia --project -e 'import Pkg; Pkg.instantiate()'
  • Run examples by navigating to the folder and execute the examples from the shell:
cd examples/validation-basak
-julia --project basak.jl
API

+julia --project basak.jl

API