PySPH Reference Documentation

Autogenerated from doc strings using sphinx’s autodoc feature.

• Module application
• Module controller
• SPH equations
  • Equation
    • Equation.converged()
  • Basic SPH Equations
  • BodyForce
    • BodyForce.initialize()
    • BodyForce.loop()
  • ContinuityEquation
    • ContinuityEquation.initialize()
    • ContinuityEquation.loop()
  • IsothermalEOS
    • IsothermalEOS.loop()
  • MonaghanArtificialViscosity
    • MonaghanArtificialViscosity.initialize()
    • MonaghanArtificialViscosity.loop()
  • SummationDensity
    • SummationDensity.initialize()
    • SummationDensity.loop()
  • VelocityGradient2D
    • VelocityGradient2D.initialize()
    • VelocityGradient2D.loop()
  • VelocityGradient3D
    • VelocityGradient3D.initialize()
    • VelocityGradient3D.loop()
  • XSPHCorrection
    • XSPHCorrection.initialize()
    • XSPHCorrection.loop()
    • XSPHCorrection.post_loop()
  • XSPHCorrectionForLeapFrog
    • XSPHCorrectionForLeapFrog.initialize()
    • XSPHCorrectionForLeapFrog.loop()
  • Basic WCSPH Equations
  • ContinuityEquationDeltaSPH
    • ContinuityEquationDeltaSPH.loop()
  • ContinuityEquationDeltaSPHPreStep
    • ContinuityEquationDeltaSPHPreStep.initialize()
    • ContinuityEquationDeltaSPHPreStep.loop()
  • MomentumEquation
    • MomentumEquation.initialize()
    • MomentumEquation.loop()
    • MomentumEquation.post_loop()
  • MomentumEquationDeltaSPH
    • MomentumEquationDeltaSPH.loop()
  • PressureGradientUsingNumberDensity
    • PressureGradientUsingNumberDensity.initialize()
    • PressureGradientUsingNumberDensity.loop()
  • TaitEOS
    • TaitEOS.loop()
  • TaitEOSHGCorrection
    • TaitEOSHGCorrection.loop()
  • UpdateSmoothingLengthFerrari
    • UpdateSmoothingLengthFerrari.loop()
  • ClearyArtificialViscosity
    • ClearyArtificialViscosity.initialize()
    • ClearyArtificialViscosity.loop()
  • LaminarViscosity
    • LaminarViscosity.loop()
  • LaminarViscosityDeltaSPH
    • LaminarViscosityDeltaSPH.loop()
  • MonaghanSignalViscosityFluids
    • MonaghanSignalViscosityFluids.loop()
  • Transport Velocity Formulation
  • ContinuityEquation
    • ContinuityEquation.initialize()
    • ContinuityEquation.loop()
  • ContinuitySolid
    • ContinuitySolid.loop()
  • MomentumEquationArtificialStress
    • MomentumEquationArtificialStress.initialize()
    • MomentumEquationArtificialStress.loop()
  • MomentumEquationArtificialViscosity
    • MomentumEquationArtificialViscosity.initialize()
    • MomentumEquationArtificialViscosity.loop()
  • MomentumEquationPressureGradient
    • MomentumEquationPressureGradient.initialize()
    • MomentumEquationPressureGradient.loop()
    • MomentumEquationPressureGradient.post_loop()
  • MomentumEquationViscosity
    • MomentumEquationViscosity.initialize()
    • MomentumEquationViscosity.loop()
  • SetWallVelocity
    • SetWallVelocity.initialize()
    • SetWallVelocity.loop()
    • SetWallVelocity.post_loop()
  • SolidWallNoSlipBC
    • SolidWallNoSlipBC.initialize()
    • SolidWallNoSlipBC.loop()
  • SolidWallPressureBC
    • SolidWallPressureBC.initialize()
    • SolidWallPressureBC.loop()
    • SolidWallPressureBC.post_loop()
  • StateEquation
    • StateEquation.loop()
  • SummationDensity
    • SummationDensity.initialize()
    • SummationDensity.loop()
  • VolumeFromMassDensity
    • VolumeFromMassDensity.loop()
  • VolumeSummation
    • VolumeSummation.initialize()
    • VolumeSummation.loop()
  • MLSFirstOrder2D
    • MLSFirstOrder2D.initialize()
    • MLSFirstOrder2D.loop_all()
  • MLSFirstOrder3D
    • MLSFirstOrder3D.initialize()
    • MLSFirstOrder3D.loop_all()
  • ShepardFilter
    • ShepardFilter.initialize()
    • ShepardFilter.loop_all()
  • Kernel Corrections
  • GradientCorrection
    • GradientCorrection.loop()
  • GradientCorrectionPreStep
    • GradientCorrectionPreStep.initialize()
    • GradientCorrectionPreStep.loop_all()
  • KernelCorrection
    • KernelCorrection.initialize()
    • KernelCorrection.loop()
  • MixedGradientCorrection
    • MixedGradientCorrection.loop()
  • MixedKernelCorrectionPreStep
    • MixedKernelCorrectionPreStep.initialize()
    • MixedKernelCorrectionPreStep.loop_all()
  • SPH Boundary Equations
  • MonaghanBoundaryForce
    • MonaghanBoundaryForce.loop()
  • MonaghanKajtarBoundaryForce
    • MonaghanKajtarBoundaryForce.loop()
  • wendland_quintic()
  • Equations for the High Velocity Impact Problems
  • MieGruneisenEOS
    • MieGruneisenEOS.loop()
  • StiffenedGasEOS
    • StiffenedGasEOS.loop()
  • VonMisesPlasticity2D
    • VonMisesPlasticity2D.loop()
  • Gas Dynamics
    • WallBoundary
  • Surface tension
  • Implicit Incompressible SPH
  • Hopkins’ ‘Traditional’ SPH (TSPH)
  • Hopkins’ ‘Modern’ SPH (PSPH)
  • Rigid body motion
    • AkinciRigidFluidCoupling
    • BodyForce
    • EulerStepRigidBody
    • LiuFluidForce
    • NumberDensity
    • PressureRigidBody
    • RK2StepRigidBody
    • RigidBodyCollision
    • RigidBodyForceGPUGems
    • RigidBodyMoments
    • RigidBodyMotion
    • RigidBodyWallCollision
    • SummationDensityBoundary
    • SummationDensityRigidBody
    • ViscosityRigidBody
    • declare()
    • get_alpha_dot()
    • get_torque()
    • skew()
  • Miscellaneous
    • Functions for advection
    • Advect
    • MixingVelocityUpdate
    • dummy_reduce_array()
    • mpi_reduce_array()
    • parallel_reduce_array()
    • serial_reduce_array()
  • Group of equations
    • Group
    • MultiStageEquations
• Integrator related modules
  • EPECIntegrator
    • EPECIntegrator.one_timestep()
  • EulerIntegrator
    • EulerIntegrator.one_timestep()
  • Integrator
    • Integrator.compute_accelerations()
    • Integrator.compute_h_minimum()
    • Integrator.compute_time_step()
    • Integrator.initial_acceleration()
    • Integrator.one_timestep()
    • Integrator.set_acceleration_evals()
    • Integrator.set_compiled_object()
    • Integrator.set_fixed_h()
    • Integrator.set_nnps()
    • Integrator.set_parallel_manager()
    • Integrator.set_post_stage_callback()
    • Integrator.step()
    • Integrator.update_domain()
  • LeapFrogIntegrator
    • LeapFrogIntegrator.one_timestep()
  • PECIntegrator
    • PECIntegrator.one_timestep()
  • PEFRLIntegrator
    • PEFRLIntegrator.one_timestep()
  • TVDRK3Integrator
    • TVDRK3Integrator.one_timestep()
  • ADKEStep
    • ADKEStep.initialize()
    • ADKEStep.stage1()
    • ADKEStep.stage2()
  • AdamiVerletStep
    • AdamiVerletStep.initialize()
    • AdamiVerletStep.stage1()
    • AdamiVerletStep.stage2()
  • EulerStep
    • EulerStep.stage1()
  • GSPHStep
    • GSPHStep.stage1()
  • GasDFluidStep
    • GasDFluidStep.initialize()
    • GasDFluidStep.stage1()
    • GasDFluidStep.stage2()
  • InletOutletStep
    • InletOutletStep.initialize()
    • InletOutletStep.stage1()
    • InletOutletStep.stage2()
  • IntegratorStep
  • LeapFrogStep
    • LeapFrogStep.stage1()
    • LeapFrogStep.stage2()
  • OneStageRigidBodyStep
    • OneStageRigidBodyStep.initialize()
    • OneStageRigidBodyStep.stage1()
    • OneStageRigidBodyStep.stage2()
  • PEFRLStep
    • PEFRLStep.stage1()
    • PEFRLStep.stage2()
    • PEFRLStep.stage3()
    • PEFRLStep.stage4()
    • PEFRLStep.stage5()
  • SolidMechStep
    • SolidMechStep.initialize()
    • SolidMechStep.stage1()
    • SolidMechStep.stage2()
  • TransportVelocityStep
    • TransportVelocityStep.initialize()
    • TransportVelocityStep.stage1()
    • TransportVelocityStep.stage2()
  • TwoStageRigidBodyStep
    • TwoStageRigidBodyStep.initialize()
    • TwoStageRigidBodyStep.stage1()
    • TwoStageRigidBodyStep.stage2()
  • VelocityVerletSymplecticWCSPHStep
    • VelocityVerletSymplecticWCSPHStep.initialize()
    • VelocityVerletSymplecticWCSPHStep.stage1()
    • VelocityVerletSymplecticWCSPHStep.stage2()
  • VerletSymplecticWCSPHStep
    • VerletSymplecticWCSPHStep.initialize()
    • VerletSymplecticWCSPHStep.stage1()
    • VerletSymplecticWCSPHStep.stage2()
  • WCSPHStep
    • WCSPHStep.initialize()
    • WCSPHStep.stage1()
    • WCSPHStep.stage2()
  • WCSPHTVDRK3Step
    • WCSPHTVDRK3Step.initialize()
    • WCSPHTVDRK3Step.stage1()
    • WCSPHTVDRK3Step.stage2()
    • WCSPHTVDRK3Step.stage3()
• SPH Kernels
  • CubicSpline
    • CubicSpline.dwdq()
    • CubicSpline.get_deltap()
    • CubicSpline.gradient()
    • CubicSpline.gradient_h()
    • CubicSpline.kernel()
  • Gaussian
    • Gaussian.dwdq()
    • Gaussian.get_deltap()
    • Gaussian.gradient()
    • Gaussian.gradient_h()
    • Gaussian.kernel()
  • QuinticSpline
    • QuinticSpline.dwdq()
    • QuinticSpline.get_deltap()
    • QuinticSpline.gradient()
    • QuinticSpline.gradient_h()
    • QuinticSpline.kernel()
  • SuperGaussian
    • SuperGaussian.dwdq()
    • SuperGaussian.get_deltap()
    • SuperGaussian.gradient()
    • SuperGaussian.gradient_h()
    • SuperGaussian.kernel()
  • WendlandQuintic
    • WendlandQuintic.dwdq()
    • WendlandQuintic.get_deltap()
    • WendlandQuintic.gradient()
    • WendlandQuintic.gradient_h()
    • WendlandQuintic.kernel()
  • WendlandQuinticC2_1D
    • WendlandQuinticC2_1D.dwdq()
    • WendlandQuinticC2_1D.get_deltap()
    • WendlandQuinticC2_1D.gradient()
    • WendlandQuinticC2_1D.gradient_h()
    • WendlandQuinticC2_1D.kernel()
  • WendlandQuinticC4
    • WendlandQuinticC4.dwdq()
    • WendlandQuinticC4.get_deltap()
    • WendlandQuinticC4.gradient()
    • WendlandQuinticC4.gradient_h()
    • WendlandQuinticC4.kernel()
  • WendlandQuinticC4_1D
    • WendlandQuinticC4_1D.dwdq()
    • WendlandQuinticC4_1D.get_deltap()
    • WendlandQuinticC4_1D.gradient()
    • WendlandQuinticC4_1D.gradient_h()
    • WendlandQuinticC4_1D.kernel()
  • WendlandQuinticC6
    • WendlandQuinticC6.dwdq()
    • WendlandQuinticC6.get_deltap()
    • WendlandQuinticC6.gradient()
    • WendlandQuinticC6.gradient_h()
    • WendlandQuinticC6.kernel()
  • WendlandQuinticC6_1D
    • WendlandQuinticC6_1D.dwdq()
    • WendlandQuinticC6_1D.get_deltap()
    • WendlandQuinticC6_1D.gradient()
    • WendlandQuinticC6_1D.gradient_h()
    • WendlandQuinticC6_1D.kernel()
  • get_compiled_kernel()
  • get_correction()
• Module nnps: Nearest Neighbor Particle Search
• Module parallel_manager
• Module particle_array
  • Convenience functions to create particle arrays
• Module scheme
  • ADKEScheme
    • ADKEScheme.configure_solver()
    • ADKEScheme.get_equations()
    • ADKEScheme.setup_properties()
  • AdamiHuAdamsScheme
    • AdamiHuAdamsScheme.add_user_options()
    • AdamiHuAdamsScheme.attributes_changed()
    • AdamiHuAdamsScheme.configure_solver()
    • AdamiHuAdamsScheme.consume_user_options()
    • AdamiHuAdamsScheme.get_equations()
    • AdamiHuAdamsScheme.setup_properties()
  • GSPHScheme
    • GSPHScheme.add_user_options()
    • GSPHScheme.configure_solver()
    • GSPHScheme.consume_user_options()
    • GSPHScheme.get_equations()
    • GSPHScheme.setup_properties()
  • GasDScheme
    • GasDScheme.add_user_options()
    • GasDScheme.configure_solver()
    • GasDScheme.consume_user_options()
    • GasDScheme.get_equations()
    • GasDScheme.setup_properties()
  • Scheme
    • Scheme.add_user_options()
    • Scheme.attributes_changed()
    • Scheme.configure()
    • Scheme.configure_solver()
    • Scheme.consume_user_options()
    • Scheme.get_equations()
    • Scheme.get_solver()
    • Scheme.setup_properties()
  • SchemeChooser
    • SchemeChooser.add_user_options()
    • SchemeChooser.attributes_changed()
    • SchemeChooser.configure()
    • SchemeChooser.configure_solver()
    • SchemeChooser.consume_user_options()
    • SchemeChooser.get_equations()
    • SchemeChooser.get_solver()
    • SchemeChooser.setup_properties()
  • TVFScheme
    • TVFScheme.add_user_options()
    • TVFScheme.configure_solver()
    • TVFScheme.consume_user_options()
    • TVFScheme.get_equations()
    • TVFScheme.get_timestep()
    • TVFScheme.setup_properties()
  • WCSPHScheme
    • WCSPHScheme.add_user_options()
    • WCSPHScheme.configure_solver()
    • WCSPHScheme.consume_user_options()
    • WCSPHScheme.get_equations()
    • WCSPHScheme.get_timestep()
    • WCSPHScheme.setup_properties()
  • add_bool_argument()
• Module solver
• Module solver tools
  • DensityCorrection
    • DensityCorrection.post_step()
  • SimpleRemesher
    • SimpleRemesher.post_step()
  • Tool
    • Tool.post_stage()
    • Tool.post_step()
    • Tool.pre_step()
• Module boundary conditions
• Module solver_interfaces
  • CommandlineInterface
  • CrossDomainXMLRPCRequestHandler
    • CrossDomainXMLRPCRequestHandler.do_GET()
    • CrossDomainXMLRPCRequestHandler.do_OPTIONS()
    • CrossDomainXMLRPCRequestHandler.end_headers()
  • MultiprocessingClient
    • MultiprocessingClient.add_interface()
    • MultiprocessingClient.start()
  • MultiprocessingInterface
    • MultiprocessingInterface.start()
  • XMLRPCInterface
• Miscellaneous Tools for PySPH
  • Input/Output of data files
  • Interpolator
  • SPH Evaluator
  • GMsh input/output
    • Extrude
    • Gmsh
    • Loop
    • Surface
    • example_3d_p()
    • example_cube()
    • example_plot_3d_p()
    • transform_points()
    • vtk_file_to_points()
  • Mayavi Viewer
  • Mesh Converter
  • Particle Packer