"""
ISPH API
==========
Module for creating an ISPH (incompressible smooth particle hydrodynamics) DYNA input deck.
"""
import logging
from .dynabase import * # noqa : F403
[docs]
class DynaISPH(DynaBase):
"""Contains methods for creating a keyword related to ISPH."""
def __init__(self):
DynaBase.__init__(self)
[docs]
self.isphanalysis = ISPHAnalysis()
[docs]
def set_des(
self,
num_timestep=1,
boxid=0,
space_dimension=3,
neighbors=150,
approximation_theory=0,
max_velocty=1e15,
):
"""Provide controls related to ISPH.
Parameters
----------
num_timestep : int, optional
Number of time steps between particle sorting. The default
is ``1``.
boxid : int, optional
Box ID. The default is ``0``. ISPH approximations are computed
inside the specified box. When a particle has gone outside this
box, it is deactivated.
space_dimension : int, optional
Space dimension for ISPH particles. The default is ``3``. Options
are:
- EQ.3: 3D problems
- EQ.2: 2D plane strain problems
- EQ.-2: 2D axisymmetric problems
neighbors : int, optional
Initial number of neighbors per particle. The default is ``150``.
approximation_theory : int, optional
Particle approximation theory. The default is ``0``.
max_velocty : float, optional
Maximum value for velocity for the ISPH particles. The default
is ``1000000000000000.0``.
Returns
-------
bool
``True`` when successful, ``False`` when failed.
"""
ret = self.stub.CreateControlSPH(
CreateControlSPHRequest(
ncbs=num_timestep,
boxid=boxid,
idim=space_dimension,
nmneigh=neighbors,
form=approximation_theory,
maxv=max_velocty,
)
)
logging.info("Control SPH Created...")
return ret
[docs]
def save_file(self):
"""Save keyword files.
Returns
-------
bool
``True`` when successful, ``False`` when failed.
"""
self.isphanalysis.create()
DynaBase.save_file(self)
[docs]
class ISPHAnalysis:
"""Provide controls related to ISPH."""
def __init__(self, num_timestep=1):
[docs]
self.stub = DynaBase.get_stub()
[docs]
self.num_timestep = num_timestep
[docs]
self.space_dimension = 3
[docs]
self.approximation_theory = 13
[docs]
self.particle_deactivation = 1e15
[docs]
self.velocity_scaling = 0
[docs]
def set_num_timestep(self, num_timestep):
"""Set the number of time steps between particle sorting.
Parameters
----------
num_timestep : int, optional
Number of time steps between particle sorting. The default
is ``1``.
"""
self.num_timestep = num_timestep
[docs]
def set_box(self, box):
"""Set the box. ISPH approximations are computed inside a specified box.
Parameters
----------
box : Box
Box for computing ISHPH approximattions. When a particle has gone
outside this box, it is deactivated.
"""
self.box = box
[docs]
def set_neighbors(self, neighbors):
"""Set the initial number of neighbors per particle.
Parameters
----------
neighbors : int, optional
Initial number of neighbors per particle.
"""
self.neighbors = neighbors
[docs]
def set_particle_deactivation(self, deactivation):
"""Set the type of BEM matrices and the way they are assembled.
Parameters
----------
deactivation :
"""
self.particle_deactivation = deactivation
[docs]
def set_velocity_scaling(self, scaling):
"""Set the type of BEM matrices and the way they are assembled.
Parameters
----------
scaling :
"""
self.velocity_scaling = scaling
[docs]
def create(self):
"""Create an ISPH analysis."""
if self.box == None:
boxid = 0
else:
boxid = self.box.create(self.stub)
if self.velocity_scaling != 0:
maxv = -self.velocity_scaling
else:
maxv = self.particle_deactivation
ret = self.stub.CreateControlSPH(
ControlSPHRequest(
ncbs=self.num_timestep,
boxid=boxid,
idim=self.space_dimension,
nmneigh=self.neighbors,
form=self.approximation_theory,
maxv=maxv,
)
)
logging.info("Control SPH Created...")
[docs]
class SPHSection:
"""Defines section properties for ISPH particles.
Parameters
----------
cslh : float, optional
hmin : float, optional
hmax : float, optional
sphini : int, optional
"""
def __init__(self, cslh=1.2, hmin=0.2, hmax=2.0, sphini=0):
stub = DynaBase.get_stub()
ret = stub.CreateSectionSPH(SectionSPHRequest(cslh=cslh, hmin=hmin, hmax=hmax, sphini=sphini))
[docs]
class MassflowPlane:
"""Measures ISPH mass flow rate across a defined plane.
Parameters
----------
particles : NodeSet, PartSet
Node set or part set specifying the ISPH particles to measure.
surface : PartSet
Part set ID or part ID defining the surface across which to measure the flow rate.
"""
def __init__(self, particles, surface):
[docs]
self.particles = particles
[docs]
def create(self, stub):
"""Create a mass flow plane."""
self.particles.create(stub)
self.surface.create(stub)
pid = self.particles.id
sid = self.surface.id
if self.particles.type == "NODESET":
ptype = 0
elif self.particles.type == "NODE":
ptype = 1
elif self.particles.type == "PARTSET":
ptype = 2
elif self.particles.type == "PART":
ptype = 3
pid = self.particles.get_pid()
else:
print("invalid set type.")
if self.surface.type == "PARTSET":
stype = 0
elif self.surface.type == "PART":
stype = 1
sid = self.surface.get_pid()
stub.CreateDefineSPHMassflowPlane(
DefineSPHMassflowPlaneRequest(prtclsid=pid, surfsid=sid, ptype=ptype, stype=stype)
)
[docs]
class ISPHFluidPart(Part):
"""Generates ISPH particles inside a box.
Parameters
----------
pid : int
Part ID.
minpoint : Point
Minimum x,y,z-coordinate.
length : Point
Box length in the x,y,z-direction.
numdirx : int
Number of ISPH particles in the x-direction.
numdiry : int
Number of ISPH particles in the y-direction.
numdirz : int
Number of ISPH particles in the z-direction.
"""
def __init__(self, pid, minpoint, length, numdirx, numdiry, numdirz):
Part.__init__(self, pid)
[docs]
self.stub = DynaBase.get_stub()
[docs]
self.type = "ISPHFLUID"
[docs]
self.minpoint = minpoint
# section
# massflow plane
[docs]
self.massflowplane = None
[docs]
def set_smoothing_length(self, initial, min, max, optional):
"""Calculate the smoothing length of the particles.
Parameters
----------
initial : float
Constant for calculating the initial smoothing length of the particles.
min : float
Scale factor for the minimum smoothing length.
max : float
Scale factor for the maximum smoothing length.
optional : float, optional
Initial smoothing length, which overrides the true smoothing length.
"""
self.cslh = initial
self.hmin = min
self.hmax = max
self.sphini = optional
[docs]
def create_particles(self):
"""Create ISPH particles inside the box."""
coords = (
self.minpoint.x,
self.minpoint.y,
self.minpoint.z,
self.length.x,
self.length.y,
self.length.z,
)
numparticles = (self.numdirx, self.numdiry, self.numdirz)
self.stub.CreateDefineSPHMeshBox(
DefineSPHMeshBoxRequest(ipid=self.id, coords=coords, numparticles=numparticles)
)
[docs]
def create_massflow_plane(self, surfaces):
"""Measure ISPH mass flow rate across a defined plane."""
self.massflowplane = MassflowPlane(PartSet([self.id]), surfaces)
[docs]
def set_property(self):
"""Set properties for an ISPH fluid part."""
self.create_particles()
self.massflowplane.create(self.stub)
sec = SPHSection(cslh=self.cslh, hmin=self.hmin, hmax=self.hmax, sphini=self.sphini)
self.secid = sec.id
self.stub.SetPartProperty(
PartPropertyRequest(
pid=self.id,
secid=self.secid,
mid=self.mid,
eosid=self.eosid,
hgid=self.hgid,
grav=self.grav,
adpopt=self.adpopt,
tmid=self.tmid,
)
)
[docs]
class ISPHStructPart(Part):
"""Generates and places ISPH elements on the surface of triangular shell elements.
Parameters
----------
pid : int
Part ID.
couple_partset : PartSet
Part or part set ID for the region of the mesh to place the ISPH elements on.
space : float
Maximum space between ISPH elements.
"""
def __init__(self, pid, couple_partset, space):
Part.__init__(self, pid)
[docs]
self.stub = DynaBase.get_stub()
[docs]
self.type = "ISPHSTRUCT"
[docs]
self.couple_partset = couple_partset
# section
[docs]
def set_smoothing_length(self, initial, min, max, optional):
"""Calculate the smoothing length of the particles.
Parameters
----------
Parameters
----------
initial : float
Constant for calculating the initial smoothing length of the particles.
min : float
Scale factor for the minimum smoothing length.
max : float
Scale factor for the maximum smoothing length.
optional : float, optional
Initial smoothing length, which overrides the true smoothing length.
"""
self.cslh = initial
self.hmin = min
self.hmax = max
self.sphini = optional
[docs]
def create_particles(self):
"""Create ISPH elements on the surface of triangular shell elements."""
sid = self.couple_partset.create(self.stub)
if self.couple_partset.type == "PARTSET":
type = 0
else:
type = 1
sid = self.couple_partset.get_pid()
self.stub.CreateDefineSPHMeshSurface(
DefineSPHMeshSurfaceRequest(sid=sid, type=type, sphpid=self.id, space=self.space)
)
[docs]
def set_property(self):
"""Set properties for the ISPH structural part."""
self.create_particles()
sec = SPHSection(cslh=self.cslh, hmin=self.hmin, hmax=self.hmax, sphini=self.sphini)
self.secid = sec.id
self.stub.SetPartProperty(
PartPropertyRequest(
pid=self.id,
secid=self.secid,
mid=self.mid,
eosid=self.eosid,
hgid=self.hgid,
grav=self.grav,
adpopt=self.adpopt,
tmid=self.tmid,
)
)
