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
  • aPriori.DNS.Mesh3D(self, folder_path):
  • Attributes
  • Methods
  1. API guide

Mesh3D

PreviousScalar3D.plot_z_midplaneNextBIBLIOGRAPHY

Last updated 1 year ago

aPriori.DNS.Mesh3D(self, folder_path):


A class used to store a 3D mesh.

This class takes three Scalar3D objects representing the X, Y, and Z coordinates of a 3D mesh. It checks that the input objects are instances of the Scalar3D class and have the same shape. The shape of the mesh is expected to be a list of three integers. The class also provides properties to access the unique values of the X, Y, and Z coordinates and their 3D representations. It also provides properties to access the X, Y, and Z coordinates at the midpoints along each axis.

Attributes

  • shape (list):

    The shape of the 3D mesh.

  • Nx (int):

    The size of the mesh along the X axis.

  • Ny (int):

    The size of the mesh along the Y axis.

  • Nz (int):

    The size of the mesh along the Z axis.

  • X (Scalar3D):

    The X coordinates of the mesh.

  • Y (Scalar3D):

    The Y coordinates of the mesh.

  • Z (Scalar3D):

    The Z coordinates of the mesh.

Methods

  • X1D():

    Returns the unique values of the X coordinates.

  • Y1D():

    Returns the unique values of the Y coordinates.

  • Z1D():

    Returns the unique values of the Z coordinates.

  • X3D():

    Returns the 3D representation of the X coordinates.

  • Y3D():

    Returns the 3D representation of the Y coordinates.

  • Z3D():

    Returns the 3D representation of the Z coordinates.

  • X_midY():

    Returns the X coordinates at the midpoint along the Y axis.

  • X_midZ():

    Returns the X coordinates at the midpoint along the Z axis.

  • Y_midX():

    Returns the Y coordinates at the midpoint along the X axis.

  • Y_midZ():

    Returns the Y coordinates at the midpoint along the Z axis.

  • Z_midX():

    Returns the Z coordinates at the midpoint along the X axis.

  • Z_midY():

    Returns the Z coordinates at the midpoint along the Y axis.