aPriori Documentation
  • 👋Welcome to aPriori
  • Getting started
    • What is aPriori?
    • Installation
    • Quickstart
  • Fundamentals and usage
    • aPriori Fundamentals
      • Data Formatting
      • Cut a 3D scalar
      • Filter a 3D scalar field
      • Initialize a DNS field
      • Data visualization
      • Cut a DNS field
      • Filter a DNS field
    • Machine Learning Tutorials
      • Data-Driven Closure for Turbulence-Chemistry interaction
      • Dynamic Data-Driven Smagorinky Closure for LES
  • API guide
    • Field3D
      • Field3D.build_attributes_list
      • Field3D.check_valid_attribute
      • Field3D.compute_chemical_timescale
      • Field3D.compute_kinetic_energy
      • Field3D.compute_mixing_timescale
      • Field3D.compute_residual_kinetic_energy
      • Field3D.compute_residual_dissipation_rate
      • Field3D.compute_reaction_rates
      • Field3D.compute_reaction_rates_batch
      • Field3D.compute_strain_rate
      • Field3D.compute_tau_r
      • Field3D.compute_velocity_module
      • Field3D.cut
      • Field3D.filter_favre
      • Field3D.filter
      • Field3D.find_path
      • Field3D.plot_x_midplane
      • Field3D.plot_y_midplane
      • Field3D.plot_z_midplane
      • Field3D.print_attributes
      • Field3D.update
    • Scalar3D
      • Scalar3D.is_light_mode
      • Scalar3D.reshape_3d
      • Scalar3D.reshape_column
      • Scalar3D.reshape_line
      • Scalar3D.cut
      • Scalar3D.filter_gauss
      • Scalar3D.plot_x_midplane
      • Scalar3D.plot_y_midplane
      • Scalar3D.plot_z_midplane
    • Mesh3D
  • BIBLIOGRAPHY
Powered by GitBook
On this page
  • Field3D.cut(self, cut_size, mode='xyz'):
  • Description
  • Parameters
  • Returns
  1. API guide
  2. Field3D

Field3D.cut

PreviousField3D.compute_velocity_moduleNextField3D.filter_favre

Last updated 1 year ago

Field3D.cut(self, cut_size, mode='xyz'):

Description

Cut a field into smaller sections based on a specified cut size.

This method cuts a field into smaller sections based on the specified cut size and mode. It creates a new folder to store the cut data and grid files. If the folder already exists, it prompts the user for confirmation before overwriting the content. The chemical path is copied to the new cut folder. Each attribute of the field is cut according to the specified cut size and mode, and the resulting sections are saved to files. Finally, the information file ('info.json') is updated with the new shape of the field.

Parameters

  • cut_size (int): The size of the cut.

  • mode (str, optional): The mode of cutting. Default is 'xyz'.

Returns

  • str: Path of the cut folder.