PySPH Reference Documentation
Autogenerated from doc strings using sphinx’s autodoc feature.
- Module application
ApplicationApplication.add_tool()Application.add_user_options()Application.configure_scheme()Application.consume_user_options()Application.create_domain()Application.create_equations()Application.create_inlet_outlet()Application.create_nnps()Application.create_particles()Application.create_scheme()Application.create_solver()Application.create_tools()Application.customize_output()Application.dump_code()Application.initialize()Application.post_process()Application.post_stage()Application.post_step()Application.pre_step()Application.read_info()Application.run()Application.setup()Application.solve()
list_all_kernels()
- Module controller
CommandManagerCommandManager.add_function()CommandManager.add_interface()CommandManager.cont()CommandManager.dispatch()CommandManager.execute_commands()CommandManager.get_particle_array_combined()CommandManager.get_particle_array_from_procs()CommandManager.get_particle_array_index()CommandManager.get_particle_array_names()CommandManager.get_prop()CommandManager.get_result()CommandManager.get_status()CommandManager.get_task_lock()CommandManager.pause_on_next()CommandManager.set_log_level()CommandManager.set_prop()CommandManager.solver_method()CommandManager.sync_commands()CommandManager.wait_for_cmd()
ControllerDummyCommin_parallel()on_root_proc()synchronized()
- SPH equations
Equation- Basic SPH Equations
BodyForceContinuityEquationIsothermalEOSMonaghanArtificialViscositySummationDensityVelocityGradient2DVelocityGradient3DXSPHCorrectionXSPHCorrectionForLeapFrog- Basic WCSPH Equations
ContinuityEquationDeltaSPHContinuityEquationDeltaSPHPreStepMomentumEquationMomentumEquationDeltaSPHPressureGradientUsingNumberDensityTaitEOSTaitEOSHGCorrectionUpdateSmoothingLengthFerrariClearyArtificialViscosityLaminarViscosityLaminarViscosityDeltaSPHMonaghanSignalViscosityFluids- Transport Velocity Formulation
ContinuityEquationContinuitySolidMomentumEquationArtificialStressMomentumEquationArtificialViscosityMomentumEquationPressureGradientMomentumEquationViscositySetWallVelocitySolidWallNoSlipBCSolidWallPressureBCStateEquationSummationDensityVolumeFromMassDensityVolumeSummation- Generalized Transport Velocity Formulation
ContinuityEquationGTVFCorrectDensityDeviatoricStressRateGTVFIntegratorGTVFSchemeGTVFStepMomentumEquationArtificialStressMomentumEquationArtificialStressSolidMomentumEquationPressureGradientMomentumEquationViscosityVelocityGradientget_particle_array_gtvf()MLSFirstOrder2DMLSFirstOrder3DShepardFilter- Kernel Corrections
GradientCorrectionGradientCorrectionPreStepKernelCorrectionMixedGradientCorrectionMixedKernelCorrectionPreStepCRKSPHCRKSPHIntegratorCRKSPHPreStepCRKSPHSchemeCRKSPHStepCRKSPHSymmetricCRKSPHUpdateGhostPropsEnergyEquationMomentumEquationNumberDensitySpeedOfSoundStateEquationSummationDensityCRKSPHVelocityGradientget_particle_array_crksph()- Predictive-Corrective Incompressible SPH (PCISPH)
ComputePressureMomentumEquationPressureGradientMomentumEquationViscosityPCISPHIntegratorPCISPHSchemePCISPHStepPredictget_particle_array_pcisph()- SPH Boundary Equations
MonaghanBoundaryForceMonaghanKajtarBoundaryForcewendland_quintic()- Basic Equations for Solid Mechanics
ElasticSolidsSchemeEnergyEquationWithStressHookesDeviatoricStressRateIsothermalEOSMomentumEquationWithStressMonaghanArtificialStressget_bulk_mod()get_particle_array_elastic_dynamics()get_shear_modulus()get_speed_of_sound()- Equations for the High Velocity Impact Problems
MieGruneisenEOSStiffenedGasEOSVonMisesPlasticity2D- Gas Dynamics
- Surface tension
AdamiColorGradientAdamiReproducingDivergenceCSFSurfaceTensionForceCSFSurfaceTensionForceAdamiColorGradientAdamiColorGradientUsingNumberDensityConstructStressMatrixInterfaceCurvatureFromDensityInterfaceCurvatureFromNumberDensityMomentumEquationPressureGradientAdamiMomentumEquationPressureGradientHuAdamsMomentumEquationPressureGradientMorrisMomentumEquationViscosityAdamiMomentumEquationViscosityMorrisMorrisColorGradientSY11ColorGradientSY11DiracDeltaShadlooViscosityShadlooYildizSurfaceTensionForceSmoothedColorSolidWallPressureBCnoDensitySummationDensitySourceMassSurfaceForceAdamiget_surface_tension_equations()
- Implicit Incompressible SPH
AdvectionAccelerationComputeAIIComputeAIIBoundaryComputeDIIComputeDIIBoundaryComputeDIJPJComputeRhoAdvectionComputeRhoBoundaryIISPHSchemeIISPHStepNormalizedSummationDensityNumberDensityPressureForcePressureForceBoundaryPressureSolvePressureSolveBoundarySummationDensitySummationDensityBoundaryUpdateGhostPressureUpdateGhostPropsViscosityAccelerationViscosityAccelerationBoundary
- Hopkins’ ‘Traditional’ SPH (TSPH)
- Hopkins’ ‘Modern’ SPH (PSPH)
- MAGMA2
IncreaseSmoothingLengthUpdateSmoothingLengthSummationDensityMPMStyleIdealGasEOSAuxiliaryGradientCorrectionMatrixFirstGradientSecondGradientEntropyBasedDissipationTriggerWallBoundaryMomentumAndEnergyStdGradMomentumAndEnergyMI1MomentumAndEnergyMI2EvaluateTildeMuSettleByArtificialPressure
- Rigid body motion
AkinciRigidFluidCouplingBodyForceEulerStepRigidBodyLiuFluidForceNumberDensityPressureRigidBodyRK2StepRigidBodyRigidBodyCollisionRigidBodyForceGPUGemsRigidBodyMomentsRigidBodyMotionRigidBodyWallCollisionSummationDensityBoundarySummationDensityRigidBodyViscosityRigidBodydeclare()get_alpha_dot()get_torque()skew()
- Miscellaneous
- Group of equations
- Integrator related modules
EPECIntegratorEulerIntegratorIntegratorIntegrator.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()
LeapFrogIntegratorPECIntegratorPEFRLIntegratorTVDRK3IntegratorADKEStepAdamiVerletStepEulerStepGSPHStepGasDFluidStepInletOutletStepIntegratorStepLeapFrogStepOneStageRigidBodyStepPEFRLStepSolidMechStepTransportVelocityStepTwoStageRigidBodyStepVelocityVerletSymplecticWCSPHStepVerletSymplecticWCSPHStepWCSPHStepWCSPHTVDRK3StepTVDRK2IntegratorTVDRK2IntegratorWithRecyclingTVDRK2Step
- SPH Kernels
- Module nnps: Nearest Neighbor Particle Search
CPUDomainManagerCellDomainManagerDomainManager.__reduce_cython__()DomainManager.__setstate_cython__()DomainManager.backendDomainManager.compute_cell_size_for_binning()DomainManager.managerDomainManager.set_cell_size()DomainManager.set_in_parallel()DomainManager.set_pa_wrappers()DomainManager.set_radius_scale()DomainManager.update()
DomainManagerBaseDomainManagerBase.__reduce_cython__()DomainManagerBase.__setstate_cython__()DomainManagerBase.cell_sizeDomainManagerBase.compute_cell_size_for_binning()DomainManagerBase.copy_propsDomainManagerBase.dimDomainManagerBase.hminDomainManagerBase.in_parallelDomainManagerBase.is_mirrorDomainManagerBase.is_periodicDomainManagerBase.mirror_in_xDomainManagerBase.mirror_in_yDomainManagerBase.mirror_in_zDomainManagerBase.n_layersDomainManagerBase.narraysDomainManagerBase.pa_wrappersDomainManagerBase.periodic_in_xDomainManagerBase.periodic_in_yDomainManagerBase.periodic_in_zDomainManagerBase.propsDomainManagerBase.radius_scaleDomainManagerBase.set_cell_size()DomainManagerBase.set_in_parallel()DomainManagerBase.set_pa_wrappers()DomainManagerBase.set_radius_scale()DomainManagerBase.xmaxDomainManagerBase.xminDomainManagerBase.xtranslateDomainManagerBase.ymaxDomainManagerBase.yminDomainManagerBase.ytranslateDomainManagerBase.zmaxDomainManagerBase.zminDomainManagerBase.ztranslate
NNPSNNPSBaseNNPSBase.__reduce_cython__()NNPSBase.__setstate_cython__()NNPSBase.brute_force_neighbors()NNPSBase.cacheNNPSBase.cell_sizeNNPSBase.dimNNPSBase.domainNNPSBase.get_nearest_particles()NNPSBase.get_nearest_particles_no_cache()NNPSBase.hminNNPSBase.is_periodicNNPSBase.n_cellsNNPSBase.narraysNNPSBase.pa_wrappersNNPSBase.particlesNNPSBase.radius_scaleNNPSBase.set_context()
NNPSParticleArrayWrapperNNPSParticleArrayWrapper.__reduce_cython__()NNPSParticleArrayWrapper.__setstate_cython__()NNPSParticleArrayWrapper.gidNNPSParticleArrayWrapper.hNNPSParticleArrayWrapper.nameNNPSParticleArrayWrapper.npNNPSParticleArrayWrapper.paNNPSParticleArrayWrapper.remove_tagged_particles()NNPSParticleArrayWrapper.tagNNPSParticleArrayWrapper.xNNPSParticleArrayWrapper.yNNPSParticleArrayWrapper.z
NeighborCache__reduce_cython__()__setstate_cython__()arange_uint()get_centroid()py_flatten()py_get_valid_cell_index()py_unflatten()LinkedListNNPSBoxSortNNPSDictBoxSortNNPSExtendedSpatialHashNNPSSpatialHashNNPS__reduce_cython__()__setstate_cython__()
- Module parallel_manager
- Module particle_array
ParticleArrayParticleArray.nameParticleArray.propertiesParticleArray.constantsParticleArray.__reduce__()ParticleArray.__setstate__()ParticleArray.add_constant()ParticleArray.add_output_arrays()ParticleArray.add_particles()ParticleArray.add_property()ParticleArray.align_particles()ParticleArray.append_parray()ParticleArray.backendParticleArray.clear()ParticleArray.constantsParticleArray.copy_over_properties()ParticleArray.copy_properties()ParticleArray.default_valuesParticleArray.empty_clone()ParticleArray.ensure_properties()ParticleArray.extend()ParticleArray.extract_particles()ParticleArray.get()ParticleArray.get_carray()ParticleArray.get_lb_props()ParticleArray.get_number_of_particles()ParticleArray.get_property_arrays()ParticleArray.get_time()ParticleArray.gpuParticleArray.has_array()ParticleArray.nameParticleArray.num_real_particlesParticleArray.output_property_arraysParticleArray.propertiesParticleArray.property_arraysParticleArray.remove_particles()ParticleArray.remove_property()ParticleArray.remove_tagged_particles()ParticleArray.resize()ParticleArray.set()ParticleArray.set_device_helper()ParticleArray.set_lb_props()ParticleArray.set_name()ParticleArray.set_num_real_particles()ParticleArray.set_output_arrays()ParticleArray.set_pid()ParticleArray.set_tag()ParticleArray.set_time()ParticleArray.set_to_zero()ParticleArray.strideParticleArray.timeParticleArray.update_backend()ParticleArray.update_min_max()
get_ghost_tag()get_local_tag()get_remote_tag()is_ghost()is_local()is_remote()- Convenience functions to create particle arrays
arange_long()create_dummy_particles()get_particle_array()get_particle_array_gasd()get_particle_array_iisph()get_particle_array_rigid_body()get_particle_array_swe()get_particle_array_tvf_fluid()get_particle_array_tvf_solid()get_particle_array_wcsph()get_particles_info()is_overloaded_method()
- Module scheme
- Module solver
SolverSolver.add_post_stage_callback()Solver.add_post_step_callback()Solver.add_pre_step_callback()Solver.append_particle_arrrays()Solver.dump_output()Solver.get_options()Solver.load_output()Solver.reorder_particles()Solver.set_adaptive_timestep()Solver.set_arrays_to_print()Solver.set_cfl()Solver.set_command_handler()Solver.set_compress_output()Solver.set_disable_output()Solver.set_final_time()Solver.set_max_steps()Solver.set_n_damp()Solver.set_output_at_times()Solver.set_output_directory()Solver.set_output_fname()Solver.set_output_only_real()Solver.set_output_printing_level()Solver.set_parallel_output_mode()Solver.set_print_freq()Solver.set_reorder_freq()Solver.set_time_step()Solver.setup()Solver.setup_solver()Solver.solve()
- Module solver tools
- Module boundary conditions
CopyNormalsandDistancesIOEvaluateInletBaseInletInfoInletOutletManagerInletOutletManager.add_io_properties()InletOutletManager.create_ghost()InletOutletManager.get_equations()InletOutletManager.get_equations_post_compute_acceleration()InletOutletManager.get_inlet_outlet()InletOutletManager.get_io_names()InletOutletManager.get_stepper()InletOutletManager.setup_iom()InletOutletManager.update_dx()
InletStepOutletBaseOutletInfoOutletStepOutletStepWithUhatUpdateNormalsAndDisplacements
- Module solver_interfaces
- Miscellaneous Tools for PySPH