Coupling between Chrono and Proteus is done in this file.
Objects (classes) starting with ‘ProtCh’ (e.g. ProtChBody) are objects that have logic specifically developed for communication between Proteus and Chrono.
Objects starting with ‘Ch’ (e.g. ChBody) are objects that only have Chrono logic associated to them.
Some ProtCh objects give access to the Chrono object: my_protchsystem = ProtChSystem() my_protchbody = ProtChBody(system=my_protchsystem) my_chbody = my_protchbody.ChBody my_chbody.SetPos(…) my_chbody.SetRot(…)
# pass the index of the boundaries (or particle index) where forces must be integrated my_protchbody.setIndexBoundary([0, 1, 2, 3]) # alternatively, if you use a Shape instance from proteus.SpatialTools # the boundaries indice will be set automatically after calling SpatialTools.assembleDomain() my_protchbody.setShape(my_shape)
proteus.mbd.CouplingFSI.ProtChSystem[source]¶Bases: object
ProtChAddedMass[source]¶mbd.CouplingFSI.ProtChAddedMass
| Type: | ProtChAddedMass |
|---|
addSubcomponent(self, subcomponent)[source]¶Adds subcomponent to system calculate_init() of subcomponent called before initial timestep prestep() and poststep of subcomponent() called at all timestep
| Parameters: | subcomponent (class instance) – class instance of subcomponent |
|---|
calculate(self, proteus_dt=None)[source]¶Does chrono system calculation for a Proteus time step Calls prestep and poststep on all subcomponents (bodies, moorings, etc) attached to the system.
| Parameters: | proteus_dt (Optional[proteus_dt]) – Manually sets a time step. The time step is set automatically when coupled with a Proteus simulation |
|---|
calculate_init(self)[source]¶Does chrono system initialisation (!) Must be called before the first calculate() call. Calls calculate_init and poststep on all subcomponents (bodies, moorings, etc) attached to the system.
findElementContainingCoordsDist(self, coords, node_guess, eN_guess, rank_guess)[source]¶Distance search of nearest node, element containing coords, and owning rank.
| Parameters: | |
|---|---|
| Returns: |
|
findElementContainingCoordsKD(self, coords)[source]¶k-d tree search of nearest node, element containing coords, and owning rank.
| Parameters: | coords (array_like) – global coordinates to look for |
|---|---|
| Returns: |
|
setMinimumSubsteps(self, int nb)[source]¶Sets the minimum nb of chrono substeps per proteus step if prot_dt=0.001 and ch_dt=0.002, there will be <nb> substeps of chrono instead of just 1.
| Parameters: | nb (int) – Minimum number of chrono substeps. |
|---|
setTimeStep(self, double dt)[source]¶Sets time step for Chrono solver. Calculations in Chrono will use this time step within the Proteus time step (if bigger) :param dt: Chrono time step size :type dt: float
proteus.mbd.CouplingFSI.ProtChBody[source]¶Bases: object
ProtChSystem[source]¶mbd.CouplingFSI.ProtChSystem
| Type: | ProtChSystem |
|---|
addPrismaticLinksWithSpring(self, ndarray pris1, ndarray pris2, double stiffness, double damping, double rest_length)[source]¶fairlead: barycenter coords pris: absolute coords pris1——-fairlead(barycenter) | | | | pris2
addSpring(self, double stiffness, double damping, ndarray fairlead, ndarray anchor, double rest_length)[source]¶addTriangleMeshFromShape(self, shape=None, __Pyx_memviewslice pos=None, __Pyx_memviewslice rot=None, bool is_static=False, bool is_convex=False, double sphereswept_thickness=0.005)[source]¶Adds triangle mesh to collision model and for IBM calculations
addTriangleMeshFromVerticesFaces(self, __Pyx_memviewslice vertices, __Pyx_memviewslice facets, __Pyx_memviewslice pos=None, __Pyx_memviewslice rot=None, bool is_static=False, bool is_convex=False, double sphereswept_thickness=0.005)[source]¶Adds triangle mesh to collision model and for IBM calculations
attachShape(self, shape, take_shape_name=True)[source]¶Attach proteus.SpatialTools shape to body. Used for automatic calculation of external forces from Proteus. Called automatically when creating a body and passing a shape instance.
| Parameters: | shape (SpatialTools.Shape) – instance of shape from proteus.SpatialTools or proteus.mprans.SpatialTools |
|---|
calculate_init(self)[source]¶Called from self.ProtChSystem.calculate_init() before simulation starts
getMoments(self)[source]¶Gives moments from fluid (Proteus) acting on body (!) Only works during proteus simulation
| Returns: | M – moments (x, y, z) as provided by Proteus |
|---|---|
| Return type: | array_like |
getPressureForces(self)[source]¶Gives pressure forces from fluid (Proteus) acting on body. (!) Only works during proteus simulation
| Returns: | F_p – pressure forces (x, y, z) as provided by Proteus |
|---|---|
| Return type: | array_like |
getRotationMatrix(self)[source]¶Gives current rotation (matrix) of body
| Returns: | rot – current rotation (matrix) of body |
|---|---|
| Return type: | array_like |
getShearForces(self)[source]¶Gives shear forces from fluid (Proteus) acting on body (!) Only works during proteus simulation
| Returns: | F_v – shear forces (x, y, z) as provided by Proteus |
|---|---|
| Return type: | array_like |
hx(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (x component)
| Parameters: |
|
|---|
hx_rotation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (x component)
| Parameters: |
|
|---|
hx_translation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (x component)
| Parameters: |
|
|---|
hy(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (y component)
| Parameters: |
|
|---|
hy_rotation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (y component)
| Parameters: |
|
|---|
hy_translation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (y component)
| Parameters: |
|
|---|
hz(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (z component)
| Parameters: |
|
|---|
hz_rotation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (z component)
| Parameters: |
|
|---|
hz_translation(self, ndarray x, double t)[source]¶BC function for mesh nodes displacement (z component)
| Parameters: |
|
|---|
poststep(self)[source]¶Called after Chrono system step. Records values to csv, broadcast new position and rotation from calculating processor to all processors for moving mesh BC.
prestep(self)[source]¶Called before Chrono system step. Sets external forces automatically from Proteus solution.
setAddedMass(self, ndarray Aij)[source]¶Sets the added mass matrix of the body
| Parameters: | added_mass (array_like) – Added mass matrix (must be 6x6 array!) |
|---|
setBoundaryFlags(self, flags)[source]¶Sets the flags of the boundaries of the body numbers must be gloabal (from domain.segmentFlags or domain.facetFlags).
| Parameters: | flags (array_like) – list of flags that belong to this body |
|---|
setConstraints(self, ndarray free_x, ndarray free_r)[source]¶Sets constraints on the body (!) Only acts on Proteus and gravity forces
| Parameters: |
|
|---|
setExternalForces(self, ndarray forces=None, ndarray moments=None)[source]¶Sets external forces to body. Called during prestep or can be called manually. If called manually, must be a Chrono only simulation.
| Parameters: |
|
|---|
setIBM(self, useIBM=True, radiusIBM=0.)[source]¶Sets IBM mode for retrieving fluid forces
| Parameters: |
|
|---|
setName(self, string name)[source]¶Sets name of body (used for csv file)
| Parameters: | name (str) – name of the body |
|---|
setPrescribedMotion(self, function)[source]¶Sets custom prescribed motion function (!) should be preferably set only if body is free and not linked to other bodies or other elements (such as moorings) as this is used only for setting moving mesh BC by enforcing position of the body at each time step. Use setPrescribedMotionPoly or setPrescribedMotionSine for functions that are safe to use with a body linked with other elements.
| Parameters: | function – must be a function of time returning an array of the absolute position of the body (numpy array of length 3: x, y, z) |
|---|
setPrescribedMotionCustom(self, __Pyx_memviewslice t, __Pyx_memviewslice x=None, __Pyx_memviewslice y=None, __Pyx_memviewslice z=None, __Pyx_memviewslice ang=None, __Pyx_memviewslice ang2=None, __Pyx_memviewslice ang3=None, double t_max=0)[source]¶Sets custom prescribed motion for body. Parameters must have the same length as the time array t
| Parameters: |
|
|---|
setPrescribedMotionPoly(self, double coeff1)[source]¶Sets polynomial prescribed motion for body
| Parameters: | coeff1 (double) – coeff1 of polynomial |
|---|
setPrescribedMotionSine(self, double a, double f)[source]¶Sets sinusoidal prescribed motion for body
| Parameters: |
|
|---|
setRecordValues(self, all_values=False, pos=False, rot=False, ang_disp=False, F=False, M=False, inertia=False, vel=False, acc=False, ang_vel=False, ang_acc=False, h_predict=False)[source]¶Sets the body attributes that are to be recorded in a csv file during the simulation.
| Parameters: |
|
|---|
Notes
To add another value manually, add to dictionary self.record_dict: key: header of the column in .csv value: list of length 2: [variable name, index within variable]
(if no index, use None)
e.g. self.record_dict[‘m’][‘mass’, None]
proteus.mbd.CouplingFSI.ProtChMesh[source]¶Bases: object
ProtChSystem[source]¶mbd.CouplingFSI.ProtChSystem
| Type: | ProtChSystem |
|---|
proteus.mbd.CouplingFSI.ProtChMoorings[source]¶Bases: object
Class for building mooring cables
| Parameters: |
|
|---|
ProtChSystem[source]¶mbd.CouplingFSI.ProtChSystem
| Type: | ProtChSystem |
|---|
attachBackNodeToBody(self, ProtChBody body)[source]¶Attaches back node to a body with ChLinkLockLock
| Parameters: | body (ProtChBody) – body to which the node will be attached |
|---|
attachFrontNodeToBody(self, ProtChBody body)[source]¶Attaches front node to a body with ChLinkLockLock
| Parameters: | body (ProtChBody) – body to which the node will be attached |
|---|
fixBackNode(self, bool fixed)[source]¶Fix back node of cable
| Parameters: | fixed (bool) – Fixes node if True |
|---|
fixFrontNode(self, bool fixed)[source]¶Fix front node of cable
| Parameters: | fixed (bool) – Fixes node if True |
|---|
getNodesAcceleration(self)[source]¶Gives array of nodes acceleration
| Returns: | pos – Array of nodes acceleration. |
|---|---|
| Return type: | np.ndarray |
getNodesD(self)[source]¶Gives direction of nodes
| Returns: | dire – Array of nodes direction. |
|---|---|
| Return type: | np.ndarray |
getNodesPosition(self)[source]¶Gives array of nodes position
| Returns: | pos – Array of nodes position. |
|---|---|
| Return type: | np.ndarray |
getNodesVelocity(self)[source]¶Gives array of nodes velocity
| Returns: | pos – Array of nodes velocity. |
|---|---|
| Return type: | np.ndarray |
setAddedMassCoefficients(self, double tangential, double normal, int segment_nb)[source]¶Sets added mass coefficients of cable
| Parameters: |
|
|---|
setContactMaterial(self, mat)[source]¶Sets contact material of the cable
| Parameters: | mat (ChMaterialSurfaceSMC) – Material of cable. |
|---|
setDragCoefficients(self, double tangential, double normal, int segment_nb)[source]¶Sets drag coefficients of cable
| Parameters: |
|
|---|
setExternalForces(self, fluid_velocity_array=None, fluid_density_array=None, fluid_acceleration_array=None)[source]¶Sets external forces acting on cables Pass fluid velocity_array as argument only for debugging (must be an array as long as the number of nodes)
setFluidVelocityFunction(self, function)[source]¶Function to build nodes
| Parameters: | function – Must be a function taking two arguments (3D coordinates and time), and returning velocity (x, y, z). |
|---|
setName(self, string name)[source]¶Sets name of cable, used for csv file
| Parameters: | name (str) – Name of cable. |
|---|
setNodesPosition(self, __Pyx_memviewslice positions=None, tangents=None)[source]¶Builds the nodes of the cable.
(!) Must be called after setNodesPositionFunction()
setNodesPositionFunction(self, function_position, function_tangent=None)[source]¶Function to build nodes
| Parameters: |
|
|---|