API Reference

• sofia.domain package
  • Submodules
    • sofia.domain.coordinate
      • CoordSys
    • sofia.domain.domain
      • Domain
      • DomainEdge
      • DomainStart
      • DomainEnd
      • symbols_or_concrete()
    • sofia.domain.grid
      • DD
      • Grid
    • sofia.domain.particle_domain
      • ParticleDomain
  • Module contents
• sofia.field package
  • Submodules
    • sofia.field.field
      • Field
      • VectorField
      • TensorField
      • component_fields()
      • fields()
    • sofia.field.grid_field
      • IndexedGridField
      • GridField
      • GridFieldLocus
    • sofia.field.locus
      • Locus
      • ScalarLocus
    • sofia.field.neighbour_sum
      • NeighbourSum
    • sofia.field.particle_field
      • ParticleField
      • IndexedParticleField
      • Neighbour
      • ParticleLocus
    • sofia.field.reductions
      • Reduce
      • Min()
      • Max()
      • Mean()
      • Sum()
      • Prod()
      • All()
      • Any()
      • Std()
      • Var()
      • Median()
      • Norm()
    • sofia.field.staggered
      • Staggered
    • sofia.field.sums
      • FieldAxisSum
      • FieldAxisCumSum
      • sum_axis()
      • integrate_axis()
    • sofia.field.transfer
      • transfer()
      • Transfer
      • TransferGridGrid
      • TransferScalarGrid
      • TransferGridScalar
      • insert_transfers()
  • Module contents
• sofia.geometry package
  • Submodules
    • sofia.geometry.geometry
      • Geometry
      • SDF
  • Module contents
    • Geometry
      • Geometry.is_commutative
      • Geometry.sdf()
      • Geometry.default_assumptions
• sofia.pde package
  • Subpackages
    • sofia.pde.fdm package
      • Submodules
      • Module contents
    • sofia.pde.rkn package
      • Submodules
      • Module contents
  • Submodules
    • sofia.pde.drawing
      • Style
      • set_theme()
      • get_style()
      • update_style()
      • draw_grid()
    • sofia.pde.jacobian
      • Jacobian
    • sofia.pde.les
    • sofia.pde.preprocess
    • sofia.pde.simulate
    • sofia.pde.wall_functions
  • Module contents
    • Del
      • Del.gradient()
      • Del.dot()
      • Del.cross()
      • Del.default_assumptions
    • Derivative
      • Derivative.side
      • Derivative.discretisation_order
      • Derivative.allow_higher_order
      • Derivative.integer_stencils
      • Derivative.allow_expand
      • Derivative.expand_terms()
      • Derivative.from_derivative()
      • Derivative.func()
      • Derivative.as_finite_difference()
      • Derivative.default_assumptions
    • as_finite_diff()
    • build_simulation()
    • curl()
    • diff()
    • diff_finite()
    • diff_upwind()
    • discretise()
    • divergence()
    • fix()
    • gradient()
    • laplacian()
    • rkn()
    • simulate()
    • eval_expr()
    • apply_boundary_conditions()
• sofia.ir package
  • Submodules
    • sofia.ir.base
      • Assignment
      • FunctionDefinition
      • FunctionCall
      • For
      • CodeBlock
      • Pass
      • Print
      • Store
      • Save
      • Load
      • Inputs
      • Outputs
      • IndicesDeclaration
      • PrintTime
      • EvalAssignment
      • CustomFunctionCall
      • SolveCirculant
      • SolveBlockTridiagonal
      • SolveSparse
      • Checkpoint
      • While
    • sofia.ir.pde
      • ProjectDivFree
      • WallModelReconstruct
      • EddyViscositySmagorinsky
      • RKn
      • WallModelUTau
    • sofia.ir.token
      • CodegenToken
      • CustomToken
  • Module contents
    • Assignment
      • Assignment.default_assumptions
    • Checkpoint
      • Checkpoint.body
      • Checkpoint.default_assumptions
      • Checkpoint.defaults
    • CodeBlock
      • CodeBlock.default_assumptions
    • CodegenToken
      • CodegenToken.default_assumptions
      • CodegenToken.defaults
    • CustomFunctionCall
      • CustomFunctionCall.name
      • CustomFunctionCall.lhs
      • CustomFunctionCall.input_args
      • CustomFunctionCall.default_assumptions
    • CustomToken
      • CustomToken.transform()
      • CustomToken.default_assumptions
      • CustomToken.defaults
      • CustomToken.doit()
    • EvalAssignment
      • EvalAssignment.default_assumptions
    • EddyViscositySmagorinsky
      • EddyViscositySmagorinsky.defaults
      • EddyViscositySmagorinsky.doit()
      • EddyViscositySmagorinsky.velocities
      • EddyViscositySmagorinsky.nu_sgs
      • EddyViscositySmagorinsky.Cs
      • EddyViscositySmagorinsky.strain_squaring
      • EddyViscositySmagorinsky.default_assumptions
    • For
      • For.length
      • For.body
      • For.output_fields
      • For.checkpoint
      • For.transform()
      • For.default_assumptions
      • For.defaults
    • FunctionCall
      • FunctionCall.name
      • FunctionCall.function_args
      • FunctionCall.default_assumptions
    • FunctionDefinition
      • FunctionDefinition.body
      • FunctionDefinition.default_assumptions
    • IndicesDeclaration
      • IndicesDeclaration.symbols
      • IndicesDeclaration.default_assumptions
    • Inputs
      • Inputs.symbols
      • Inputs.default_assumptions
    • Load
      • Load.filename
      • Load.fields
      • Load.clip_larger
      • Load.default_assumptions
      • Load.defaults
    • Outputs
      • Outputs.symbols
      • Outputs.default_assumptions
    • Pass
      • Pass.default_assumptions
    • Print
      • Print.print_args
      • Print.format_string
      • Print.file
      • Print.default_assumptions
    • PrintTime
      • PrintTime.show
      • PrintTime.default_assumptions
      • PrintTime.defaults
    • ProjectDivFree
      • ProjectDivFree.defaults
      • ProjectDivFree.doit()
      • ProjectDivFree.velocities
      • ProjectDivFree.pressure
      • ProjectDivFree.bcs
      • ProjectDivFree.default_assumptions
    • RKn
      • RKn.F
      • RKn.order
      • RKn.dt
      • RKn.post
      • RKn.transform()
      • RKn.default_assumptions
      • RKn.defaults
    • Save
      • Save.out_folder
      • Save.fields
      • Save.sequential
      • Save.overwrite
      • Save.downcast_dtype
      • Save.use_threading
      • Save.default_assumptions
      • Save.defaults
    • SolveBlockTridiagonal
      • SolveBlockTridiagonal.x
      • SolveBlockTridiagonal.exprs
      • SolveBlockTridiagonal.b
      • SolveBlockTridiagonal.default_assumptions
      • SolveBlockTridiagonal.defaults
    • SolveCirculant
      • SolveCirculant.x
      • SolveCirculant.expr
      • SolveCirculant.b
      • SolveCirculant.default_assumptions
    • SolveSparse
      • SolveSparse.x
      • SolveSparse.exprs
      • SolveSparse.b
      • SolveSparse.transpose
      • SolveSparse.scale_rows
      • SolveSparse.default_assumptions
      • SolveSparse.defaults
    • WallModelReconstruct
      • WallModelReconstruct.defaults
      • WallModelReconstruct.doit()
      • WallModelReconstruct.wall_fn
      • WallModelReconstruct.y_plus
      • WallModelReconstruct.velocities
      • WallModelReconstruct.geometry
      • WallModelReconstruct.nu
      • WallModelReconstruct.band
      • WallModelReconstruct.match_height
      • WallModelReconstruct.maxiter
      • WallModelReconstruct.max_dist
      • WallModelReconstruct.side
      • WallModelReconstruct.default_assumptions
    • WallModelUTau
      • WallModelUTau.defaults
      • WallModelUTau.doit()
      • WallModelUTau.wall_fn
      • WallModelUTau.y_plus
      • WallModelUTau.query
      • WallModelUTau.velocities
      • WallModelUTau.geometry
      • WallModelUTau.nu
      • WallModelUTau.band
      • WallModelUTau.match_height
      • WallModelUTau.maxiter
      • WallModelUTau.max_dist
      • WallModelUTau.side
      • WallModelUTau.default_assumptions
    • While
      • While.condition
      • While.body
      • While.max_iter
      • While.n_iter
      • While.transform()
      • While.default_assumptions
      • While.defaults