ICFDAnalysis#

class ansys.dyna.core.pre.dynaicfd.ICFDAnalysis#

Bases: ansys.dyna.core.pre.dynabase.BaseObj

Activates an ICFD analysis and defines associated control parameters.

Overview#

set_type

Set the type of the CFD analysis.

set_output

Modify default values for screen and file outputs related to the fluid solver only.

set_fsi

Modify default values for the fluid-structure interaction coupling algorithm.

set_steady_state

Set convergence options for the steady state solver.

set_timestep

Set the time step for the fluid problem.

set_volume_mesh

Modify the default value for automatic volume mesh generation.

set_mesh_adaptivity

Activate the adaptive mesh refinement feature.

set_surface_mesh

Enable automatic surface remeshing.

set_coupling_dem

Activate coupling between the ICFD and DEM solvers.

create

Create ICFD analysis.

Import detail#

from ansys.dyna.core.pre.dynaicfd import ICFDAnalysis

Attribute detail#

ICFDAnalysis.defined_timestep = False#
ICFDAnalysis.defined_volumemesh = False#
ICFDAnalysis.defined_surfmesh = False#
ICFDAnalysis.defined_type = False#
ICFDAnalysis.defined_output = False#
ICFDAnalysis.defined_fsi = False#
ICFDAnalysis.defined_steady_state = False#
ICFDAnalysis.defined_coupling_dem = False#
ICFDAnalysis.defined_mesh_adapt = False#
ICFDAnalysis.stub#
ICFDAnalysis.type = 'analysis_icfd'#

Method detail#

ICFDAnalysis.set_type(analysis_type=ICFD_AnalysisType.TRANSIENT_ANALYSIS)#

Set the type of the CFD analysis.

Parameters:
analysis_typeICFD_AnalysisType

Analysis type. The default is TRANSIENT_ANALYSIS.

ICFDAnalysis.set_output(messagelevel=ICFD_MessageLevel.TIMESTEP_INFORMATION, iteration_interval=0)#

Modify default values for screen and file outputs related to the fluid solver only.

Parameters:
messagelevelICFD_MessageLevel, optional

Message level. The default is TIMESTEP_INFORMATION.

iteration_intervalint, optional

Iteration interval to print the output at. The default is 0.

ICFDAnalysis.set_fsi(couplingdir=ICFD_CouplingDirection.TWO_WAY_COUPLING)#

Modify default values for the fluid-structure interaction coupling algorithm.

Parameters:
couplingdirICFD_CouplingDirection, optional

Coupling direction to the solver. The default is TWO_WAY_COUPLING.

ICFDAnalysis.set_steady_state(max_iteration=1000000.0, momentum_tol_limit=0.001, pressure_tol_limit=0.001, temperature_tol_limit=0.001, velocity_relax_param=0.3, pressure_relax_param=0.7)#

Set convergence options for the steady state solver.

Parameters:
max_iterationint, optional

Maximum number of iterations to reach convergence. The default is 1000000.0.

momentum_tol_limitfloat, optional

Tolerance limits for the momentum equations. The default is 0.001.

pressure_tol_limitfloat, optional

Tolerance limits for the pressure equations. The default is 0.001.

temperature_tol_limitfloat, optional

Tolerance limits for the temperature equations. The default is 0.001.

velocity_relax_paramfloat, optional

Relaxation parameters for the velocity. The default is 0.3.

pressure_relax_paramfloat, optional

Relaxation parameters for the pressure. The default is 0.7.

ICFDAnalysis.set_timestep(timestep=0)#

Set the time step for the fluid problem.

Parameters:
dtfloat, optional

Time step for the fluid problem. The default is 0.

ICFDAnalysis.set_volume_mesh(mesh_growth_scale_factor=1.41)#

Modify the default value for automatic volume mesh generation.

Parameters:
mesh_growth_scale_factorfloat, optional

Maximum mesh size that the volume mesher is allowed to use when generating the volume mesh. The default is 1.41.

ICFDAnalysis.set_mesh_adaptivity(min_mesh_size=0, max_mesh_size=0, max_perceptual_error=0, num_iteration=0)#

Activate the adaptive mesh refinement feature.

Parameters:
min_mesh_sizefloat, optional

Minimum mesh size for the mesh generator. The default is 0.

max_mesh_sizefloat, optional

Maximum mesh size. The default is 0.

max_perceptual_errorfloat, optional

Maximum perceptual error allowed in the whole domain. The default is 0.

num_iterationint, optional

Number of iterations before a forced remeshing. The default is 0.

ICFDAnalysis.set_surface_mesh(remesh_method=ICFD_SurfRemeshMethod.LAPLACIAN_SMOOTHING)#

Enable automatic surface remeshing.

Parameters:
remesh_methodICFD_SurfRemeshMethod, optional

Whether to perform a surface remeshing. The default is LAPLACIAN_SMOOTHING.

ICFDAnalysis.set_coupling_dem(coupling_type=0, birth_time=0, death_time=1e+28, scale_factor=1, formulation=ICFD_CouplingForm.FORCE_BASED_ON_VELOCITY_DRAG_VALUE)#

Activate coupling between the ICFD and DEM solvers.

Parameters:
coupling_typeint, optional

Coupling direction to the solver. The default is 0.

birth_timefloat, optional

Birth time for the DEM coupling. The default is 0.

death_timefloat, optional

Death time for the DEM coupling. The default is 1e+28.

scale_factorfloat, optional

Scale factor applied to the force transmitted by the fluid to the structure. The default is 1.

formulationint, optional

Type of formulation to use in the coupling. The default is FORCE_BASED_ON_VELOCITY_DRAG_VALUE.

ICFDAnalysis.create()#

Create ICFD analysis.