pterasoftware.steady_ring_vortex_lattice_method

Contains the SteadyRingVortexLatticeMethodSolver class.

Classes

SteadyRingVortexLatticeMethodSolver

A class used to solve SteadyProblems with the ring vortex lattice method.

Module Contents

class pterasoftware.steady_ring_vortex_lattice_method.SteadyRingVortexLatticeMethodSolver(steady_problem: pterasoftware.problems.SteadyProblem)

A class used to solve SteadyProblems with the ring vortex lattice method.

Contains the following methods:

run: Runs the solver on the SteadyProblem.

calculate_solution_velocity: Finds the fluid velocity (in the first Airplane’s geometry axes, observed from the Earth frame) at one or more points (in the first Airplane’s geometry axes, relative to the first Airplane’s CG) due to the freestream velocity and the induced velocity from every ring vortex and horseshoe vortex.

Citation:

Adapted from: aerodynamics.vlm3.py in AeroSandbox

Author: Peter Sharpe

Date of retrieval: 04/28/2020

Parameters:

steady_problem – The SteadyProblem to be solved.

Returns:

None

run(calculate_streamlines: bool | numpy.bool_ = True) → None

Runs the solver on the SteadyProblem.

Parameters:

calculate_streamlines – Determines whether to calculate the streamlines emanating from the back of the wing after running the solver. Can be a bool or a numpy bool and will be converted internally to a bool. The default is True.

Returns:

None

calculate_solution_velocity(stackP_GP1_CgP1: numpy.ndarray | collections.abc.Sequence[collections.abc.Sequence[float | int]], bound_singularity_counts: numpy.ndarray | None = None) → numpy.ndarray

Finds the fluid velocity (in the first Airplane’s geometry axes, observed from the Earth frame) at one or more points (in the first Airplane’s geometry axes, relative to the first Airplane’s CG) due to the freestream velocity and the induced velocity from every ring vortex and horseshoe vortex.

When an image surface is defined on the OperatingPoint, the returned velocity also includes the induced velocity from image ring vortices and image horseshoe vortices reflected across that surface.

Notes:

This method assumes that the correct strengths for the ring vortices and horseshoe vortices have already been calculated and set.

Parameters:

• stackP_GP1_CgP1 – An array-like object of numbers (int or float) with shape (N,3) representing the positions of the evaluation points (in the first Airplane’s geometry axes, relative to the first Airplane’s CG). Can be a tuple, list, or ndarray. Values are converted to floats internally. The units are in meters.

• bound_singularity_counts – An optional (4,) ndarray of int64 for accumulating singularity event counts from bound ring vortices and horseshoe vortices. If None, counts are discarded.

Returns:

A (N,3) ndarray of floats representing the velocity (in the first Airplane’s geometry axes, observed from the Earth frame) at each evaluation point due to the summed effects of the freestream velocity and the induced velocity from every ring vortex and horseshoe vortex. The units are in meters per second.