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
  • Scalar3D.plot_y_midplane(self, mesh, title='', colormap='viridis', vmin=None, vmax=None):
  • Description
  • Parameters
  • Returns
  1. API guide
  2. Scalar3D

Scalar3D.plot_y_midplane

PreviousScalar3D.plot_x_midplaneNextScalar3D.plot_z_midplane

Last updated 1 year ago

Scalar3D.plot_y_midplane(self, mesh, title='', colormap='viridis', vmin=None, vmax=None):

Description

Plots the y midplane of a 3D field.

This method plots the x midplane of a 3D field using the provided mesh. It uses the midpoint of the x-axis to generate a 2D plot of the field values at that plane.

Parameters

  • mesh (object): The mesh object containing the coordinates.

  • title (str, optional): The title of the plot. Default is an empty string.

  • colormap (str, optional): The colormap to use for the plot. Default is 'viridis'.

  • vmin (float, optional): The minimum value for the color scale. Default is None.

  • vmax (float, optional): The maximum value for the color scale. Default is None.

Returns

  • None