|
Apame C++ API 0.0.20261017
Aerodynamic panel method solver
|
#include <apame.h>
Public Member Functions | |
| virtual void | setCallback (IApameCallback *callback, bool printProgressBar=true)=0 |
| virtual const char * | getApameErrorDescription (APAME_ERROR code)=0 |
| Returns Apame error description. | |
| virtual APAME_ERROR | allocateNodes (int numNodes)=0 |
| virtual void | addNode (float *coordinates)=0 |
| virtual APAME_ERROR | storeNodes (int numNodes, float *coordinates)=0 |
| virtual APAME_ERROR | allocatePanels (int numPanels)=0 |
| virtual APAME_ERROR | addBodyPanel (const PANEL_TYPE type, const int *nodes, int component)=0 |
| virtual int | getNumComponents ()=0 |
| virtual int | getNumWakeNodes ()=0 |
| virtual float * | getWakeNodes ()=0 |
| virtual int | getNumWakePanels ()=0 |
| virtual APAME_ERROR | getWakePanelInfo (int panelIndex, int &numNodes, int *nodes, int *trailingPanels)=0 |
| virtual APAME_ERROR | setFarField (float farField)=0 |
| virtual float | getFarField ()=0 |
| virtual APAME_ERROR | setCollDepth (float collDepth)=0 |
| virtual float | getCollDepth ()=0 |
| virtual APAME_ERROR | setNeighboringAngle (float angle)=0 |
| virtual float | getNeighboringAngle ()=0 |
| virtual APAME_ERROR | setTimeStep (float timeStep)=0 |
| virtual float | getTimeStep ()=0 |
| virtual void | setWakeRequest (bool wakeRequest)=0 |
| virtual bool | getWakeRequest ()=0 |
| virtual APAME_ERROR | setWakeAngle (float angle)=0 |
| virtual float | getWakeAngle ()=0 |
| virtual APAME_ERROR | setWakeLength (float length)=0 |
| virtual float | getWakeLength ()=0 |
| virtual APAME_ERROR | setNumWakeRows (int numWakeRows)=0 |
| virtual int | getNumWakeRowsSteady ()=0 |
| virtual int | getNumWakeRowsTrans ()=0 |
| virtual APAME_ERROR | setWakePropagation (int propType)=0 |
| virtual int | getWakePropagation ()=0 |
| virtual APAME_ERROR | setWakePropAngle (float angle)=0 |
| virtual float | getWakePropAngle ()=0 |
| virtual APAME_ERROR | setWakePropMinScaling (float minScaling)=0 |
| virtual float | getWakePropMinScaling ()=0 |
| virtual APAME_ERROR | setSingularity (int singularityType)=0 |
| virtual int | getSingularity ()=0 |
| virtual void | addCaseInBodyCs (float x, float y, float z)=0 |
| virtual void | addCaseInAeroCs (float airspeed, float alfa, float beta)=0 |
| virtual int | getNumberOfCases ()=0 |
| virtual float * | getCases ()=0 |
| virtual APAME_ERROR | setCurvature (int curvatureType)=0 |
| virtual int | getCurvature ()=0 |
| virtual APAME_ERROR | setDensity (float density)=0 |
| virtual float | getDensity ()=0 |
| virtual APAME_ERROR | setMach (float mach)=0 |
| virtual float | getMach ()=0 |
| virtual APAME_ERROR | setRefPressure (float pressure)=0 |
| virtual float | getRefPressure ()=0 |
| virtual void | setOrigin (float x, float y, float z)=0 |
| virtual float * | getOrigin ()=0 |
| virtual APAME_ERROR | setArea (float area)=0 |
| virtual float | getArea ()=0 |
| virtual APAME_ERROR | setSpan (float span)=0 |
| virtual float | getSpan ()=0 |
| virtual APAME_ERROR | setMac (float mac)=0 |
| virtual float | getMac ()=0 |
| virtual void | setCalculationRequests (int calculationRequests)=0 |
| virtual int | getCalculationRequests ()=0 |
| virtual APAME_ERROR | runSteadyStateAnalysis ()=0 |
| virtual APAME_ERROR | initializeTransientAnalysis ()=0 |
| virtual APAME_ERROR | runTransientAnalysisStep ()=0 |
| virtual void | addPanelVelocities (const float *velocities)=0 |
| virtual float | getProgress ()=0 |
| virtual void | requestStop ()=0 |
| Requests termination of supported tasks. | |
| virtual void | requestPause ()=0 |
| Requests pause of supported tasks. | |
| virtual void | requestResume ()=0 |
| Requests resume of supported tasks. | |
| virtual APAME_ERROR | getWakePanelScaling (int panelIndex, float &wakeScaling)=0 |
| virtual APAME_ERROR | getWakePanelStrength (int panelIndex, int caseIndex, float &wakeStrength)=0 |
| virtual float | getAeroForce (int caseIndex, int dir, int component=-1)=0 |
| virtual float | getBodyForce (int caseIndex, int dir, int component=-1)=0 |
| virtual float | getMoment (int caseIndex, int dir, int component=-1)=0 |
| virtual float | getAeroForceCoef (int caseIndex, int dir, int component=-1)=0 |
| virtual float | getBodyForceCoef (int caseIndex, int dir, int component=-1)=0 |
| virtual float | getMomentCoef (int caseIndex, int dir, int component=-1)=0 |
| virtual float * | getFieldResult (int field)=0 |
| virtual int | getPlaneCut (const float origin[3], const float dirH[3], const float dirV[3], const int field, float **outPoints, float **outValues, int **outCurveStart, int **outCurveClosed, int *outTotalPoints, const int numComponents=0, const int *components=nullptr)=0 |
| virtual void | getForceDistributionCurve (const float dirU[3], const float dirV[3], const int numPoints, float *pointCoords, float *forces, const int caseIndex=0, const int numComponents=0, const int *components=nullptr)=0 |
| virtual void | getLiftDistributionCurve (const float dirU[3], const int numPoints, float *pointCoords, float *forces, const int caseIndex=0, const int numComponents=0, const int *components=nullptr)=0 |
| virtual void | clearCalculationRequests ()=0 |
| Clears calculation requests. | |
| virtual void | clearCases ()=0 |
| Clears cases. | |
| virtual void | clearPanels ()=0 |
| Clears panels. | |
| virtual void | clearNodes ()=0 |
| Clears nodes. | |
| virtual void | clearPlaneCuts ()=0 |
| Clears plane cuts. | |
| virtual void | clear ()=0 |
| Clears everything. | |
| virtual void | releaseLicense ()=0 |
| virtual const char * | getLicenseStamp ()=0 |
|
pure virtual |
Sets Apame callback interface
| callback | - Pointer to callback interface |
| printProgressBar | - Print progress bar |
|
pure virtual |
Returns Apame error description.
|
pure virtual |
Allocates nodes in order to speed up the node addition process
| numNodes | - Number of nodes to allocate |
|
pure virtual |
Adds node with given coordinates
| coordinates | - Array of node coordinates (x,y,z) |
|
pure virtual |
Store full node array
| numNodes | - Number of nodes |
| coordinates | - Array of node coordinates (x,y,z) |
|
pure virtual |
Allocates panels in order to speed up the panel addition process
| numPanels | - Number of panels to allocate |
|
pure virtual |
Adds body panel to Apame object
| type | - Panel type |
| nodes | - Node indexes of panel |
| component | - Component ID |
|
pure virtual |
Gets number of components
|
pure virtual |
Gets number of wake nodes
|
pure virtual |
Gets wake nodes
|
pure virtual |
Gets number of wake panels
|
pure virtual |
Gets wake panel information
| panelIndex | - Wake panel index |
| numNodes | - Number of nodes |
| nodes | - Array of node indices |
| trailingPanels | - Array of trailing panel indices |
|
pure virtual |
Sets far-field coefficient
| farField | - Far-field coefficient |
|
pure virtual |
|
pure virtual |
Sets collocation depth
| collDepth | - Collocation depth |
|
pure virtual |
|
pure virtual |
Sets neighboring angle threshold
| angle | - Neighboring angle threshold |
|
pure virtual |
|
pure virtual |
Sets time step size (for transient analysis)
| timeStep | - Time step size |
|
pure virtual |
|
pure virtual |
Sets wake request
| wakeRequest | - Wake request flag |
|
pure virtual |
|
pure virtual |
Sets wake angle threshold
| angle | - Wake angle threshold |
|
pure virtual |
|
pure virtual |
Sets wake length
| length | - Wake length |
|
pure virtual |
|
pure virtual |
Sets number of wake rows (steady state analysis only)
| numWakeRows | - Number of wake rows |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Sets wake propagation request
| propType | - Wake propagation request type |
|
pure virtual |
|
pure virtual |
Sets wake propagation angle
| angle | - Wake propagation angle |
|
pure virtual |
|
pure virtual |
Sets wake propagation minimum scaling (end wake strength scaling)
| minScaling | - Minimum scaling in ratio |
|
pure virtual |
|
pure virtual |
Sets singularity type
| singularityType | - Singularity type |
|
pure virtual |
|
pure virtual |
Adds case in body coordinate system
| x | - X coordinate |
| y | - Y coordinate |
| z | - Z coordinate |
|
pure virtual |
Adds case in aerodynamic coordinate system
| airspeed | - Airspeed |
| alfa | - Angle of attack (in radians) |
| beta | - Sideslip angle (in radians) |
|
pure virtual |
Gets number of cases
|
pure virtual |
Gets cases
|
pure virtual |
Sets curvature correction
| curvatureType | - Curvature correction type |
|
pure virtual |
|
pure virtual |
Sets air density
| density | - Air density |
|
pure virtual |
|
pure virtual |
Sets Mach number for compressibility correction
| mach | - Mach number |
|
pure virtual |
|
pure virtual |
Sets reference pressure
| pressure | - Reference pressure |
|
pure virtual |
|
pure virtual |
Sets origin coordinates
| x | - Origin X coordinate |
| y | - Origin Y coordinate |
| z | - Origin Z coordinate |
|
pure virtual |
|
pure virtual |
Sets wing surface area reference value
| area | - Wing surface area |
|
pure virtual |
|
pure virtual |
Sets wing span (span) reference value
| span | - Wing span |
|
pure virtual |
|
pure virtual |
Sets mean aerodynamic chord (length) reference value
| mac | - Mean aerodynamic chord (length) |
|
pure virtual |
|
pure virtual |
Sets calculation requests
| calculationRequests | - Calculation requests |
|
pure virtual |
|
pure virtual |
Runs steady state analysis
|
pure virtual |
Initializes transient analysis
|
pure virtual |
Runs transient analysis step
|
pure virtual |
Adds velocities at collocation points due to structural motion (i.e. oscillations or rotation)
| velocities | - Array of velocity components (vx,vy,vz) for each panel |
|
pure virtual |
Returns progress of supported tasks
|
pure virtual |
Requests termination of supported tasks.
|
pure virtual |
Requests pause of supported tasks.
|
pure virtual |
Requests resume of supported tasks.
|
pure virtual |
Gets wake panel scaling coefficient field
| panelIndex | - Wake panel index |
| wakeScaling | - Wake panel scaling coefficient |
|
pure virtual |
Gets wake panel strength field
| panelIndex | - Wake panel index |
| caseIndex | - Case index |
| wakeStrength | - Wake panel strength |
|
pure virtual |
Gets force in aerodynamic coordinate system
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets force in body coordinate system
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets moment
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets force coefficient in aerodynamic coordinate system
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets force coefficient in body coordinate system
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets moment coefficient
| caseIndex | - Case index |
| dir | - Direction (0=X, 1=Y, 2=Z) |
| component | - Component index |
|
pure virtual |
Gets field result
| field | - Field result component |
|
pure virtual |
Performs a planar cut of the geometry and evaluates the selected field at cut points
| origin | - Plane origin [x, y, z] |
| dirH | - Horizontal direction vector (defines local U axis) |
| dirV | - Vertical direction vector (defines local V axis) |
| field | - Field to evaluate (velocity, pressure coefficient, etc.) |
| outPoints | - Output array of 3D points (x1, y1, z1, x2, y2, z2, ...) |
| outValues | - Output array of field values at each point |
| outCurveStart | - Output array of curve start indices (for each curve) |
| outCurveClosed | - Output array of flags (0=open, 1=closed) for each curve |
| outTotalPoints | - Total number of points in all curves |
| numComponents | - Number of components to evaluate (if 0, all components are evaluated) |
| components | - Array of components to evaluate |
|
pure virtual |
Gets force distribution curve in specified plane
| dirU | - Span direction vector |
| dirV | - Force direction vector |
| numPoints | - Number of output points in span direction |
| pointCoords | - Output array of span coordinates |
| forces | - Output array of forces per unit length |
| caseIndex | - Case index (default 0 - first case) |
| numComponents | - Number of components to evaluate (if 0, all components are evaluated) |
| components | - Array of components to evaluate |
|
pure virtual |
Gets lift distribution curve in specified direction
| dirU | - Span direction vector |
| numPoints | - Number of output points in span direction |
| pointCoords | - Output array of span coordinates |
| forces | - Output array of forces per unit length |
| caseIndex | - Case index (default 0 - first case) |
| numComponents | - Number of components to evaluate (if 0, all components are evaluated) |
| components | - Array of components to evaluate |
|
pure virtual |
Clears calculation requests.
|
pure virtual |
Clears cases.
|
pure virtual |
Clears panels.
|
pure virtual |
Clears nodes.
|
pure virtual |
Clears plane cuts.
|
pure virtual |
Clears everything.
|
pure virtual |
Gives the license of the active task back to the license server. The model and its results are kept; the next run takes the license again. To be called when the task this solver belongs to is closed, so that its license is free at once (deleting the solver does the same).
|
pure virtual |
Returns the line that identifies the registered user and the type of the license, as it is put on everything the software produces (asked from the license server).