DPF Framework 2026 R1

mesh:mesh clipper

Last update: 31.07.2026

Version: 0.0.0

Description

Clips a volume mesh along an iso value x, and construct the volume mesh defined by v < x.

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

Pin number Name Status Expected type(s)
0 field Required field
1 iso_value Required double
2 closed_surface Required int32
3 mesh abstract_meshed_region
4 slice_surfaces Required bool

field (Pin 0)

  • Required: Yes
  • Expected type(s): field

iso_value (Pin 1)

  • Required: Yes
  • Expected type(s): double

iso value

closed_surface (Pin 2)

  • Required: Yes
  • Expected type(s): int32

1: closed surface, 0: iso surface.

mesh (Pin 3)

slice_surfaces (Pin 4)

  • Required: Yes
  • Expected type(s): bool

True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true.

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

Pin number Name Expected type(s)
0 field field
2 mesh meshed_region

field (Pin 0)

  • Expected type(s): field

mesh (Pin 2)

Configurations

This operator supports configuration options that modify its behavior.

mutex

  • Expected type(s): bool
  • Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: mesh

Plugin: core

Scripting name: mesh_clip

Full name: mesh.mesh_clip

Internal name: mesh_clip

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

C++ 
#include "dpf_api.h"

ansys::dpf::Operator op("mesh_clip"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_iso_value);
op.connect(2, my_closed_surface);
op.connect(3, my_mesh);
op.connect(4, my_slice_surfaces);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
ansys::dpf::MeshedRegion my_mesh = op.getOutput<ansys::dpf::MeshedRegion>(2);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.mesh.mesh_clip() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.iso_value.connect(my_iso_value)
op.inputs.closed_surface.connect(my_closed_surface)
op.inputs.mesh.connect(my_mesh)
op.inputs.slice_surfaces.connect(my_slice_surfaces)
my_field = op.outputs.field()
my_mesh = op.outputs.mesh()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.mesh.mesh_clip() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.iso_value.Connect(my_iso_value)
op.inputs.closed_surface.Connect(my_closed_surface)
op.inputs.mesh.Connect(my_mesh)
op.inputs.slice_surfaces.Connect(my_slice_surfaces)
my_field = op.outputs.field.GetData()
my_mesh = op.outputs.mesh.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys