From Adams Vibration.AvAMD import *
Constructor:
AvAMD(fName)
Constructor
Returns: object
Parameters:
string fName: Name of the adm file with the Adams Solver model in it
Adams_OBJECT Model()
Get the key to the model
Returns: int - the key to the model
Parameters: None
Adams_OBJECT Ground()
Get the key to the ground object
Returns: int - the key to ground
Parameters: None
int AdamsID(Object)
Get the objects Adams ID
Returns: int - the id assigned to the object
Parameters:
Object - Adams_OBJECT database object to get the id from
Adams_OBJECT CreateVariable(func)
Create a solver variable in the database
Returns: int - the key to the variable
Parameters:
func - string solver function
list PartList()
Get a list of parts in the model
Returns: list - list of keys
Parameters: None
list MarkerList(part)
Get a list of markers for the given part
Returns: list - list of markers
Parameters:
part - Adams_OBJECT part to get the markers from
list StateMatrixList(results)
Get a list of state matrix objects for the given results object
Returns: list - list of state matrix
Parameters:
results - Adams_OBJECT results object to get the state matrix from
Adams_OBJECT PartFromMarker(markerID)
Get the markers parent
Returns: Adams_OBJECT - key of the parent part
Parameters:
markerID - int Adams ID of the marker
Adams_OBJECT CreateMarker(partId, dir)
Create a marker in the database
Returns: Adams_OBJECT - key of the marker
Parameters:
partID - int Adams ID of the parent part
dir - char direction to align Z axis
string ObjName(dbObject)
Get the name of the database object
Returns: string - Name of the object
Parameters:
dbObject - Adams_OBJECT database object to get name from
string MarkerName(markerID)
Get the name of the marker
Returns: string - Name of the marker
Parameters:
markerID - int Adams ID of the marker
Adams_OBJECT CreateSForce(iMarkId, jMarkId, action, type, func)
Create an SFORCE in the database
Returns: Adams_OBJECT - key to the SFORCE
Parameters:
iMarkId - int Adams ID of the I marker
jMarkId - int Adams ID of the J marker
action - string "ACTIONONLY" or None
type - string "Translational" or "Rotational"
func - string solver function
Adams_OBJECT CreateResults()
Create a results object in the database
Returns: Adams_OBJECT - key to the results object
Parameters: None
bool WriteADM(fName)
Write the model to a solver database file
Returns: bool - true for success
Parameters:
fName - string name of the adm file to write
Adams_OBJECT CreatePInput(varIDs)
Create a plant input object in the database
Returns: Adams_OBJECT - key to the plant input object
Parameters:
varIDs - list of Adams ID's of the solver variables for the plant input
Adams_OBJECT CreatePOutput(const int*) const;
Create a plant output object in the database
Returns: Adams_OBJECT - key to the plant output object
Parameters:
varIDs - list of Adams ID's of the solver variables for the plant output
double DM(iMarkID, jMarkID)
Get the distance between two markers
Returns: double - distance between markers
Parameters:
iMarkID - Adams ID of the I marker
jMarkID - Adams ID of the J marker
int DiffID()
Get the Adams ID to assign to the next DIFF
Returns: int - Adams ID of the DIFF
Parameters: None
Adams_OBJECT CreateDiff(id, func, IC)
Create a DIFF object in the database
Returns: Adams_OBJECT - key to the DIFF object
Parameters:
id - Adams ID if the DIFF to create
func - string solver function for the DIFF
IC - double DIFF initial value for the DIFF
Adams_OBJECT CreateMatrix(nRow, nCol, order, data)
Create a matrix object in the database
Returns: Adams_OBJECT - key to the matrix object
Parameters:
nRow - int number of rows
nCol - int number of columns
order - string Row order or Column order of the data
data - list matrix values
Adams_OBJECT CreateArray(which, data)
Create an array object in the database
Returns: Adams_OBJECT - key to the array object
Parameters:
which - character X, Y, U, I
data - string optional values for the array used with I & U
Adams_OBJECT CreateLSE(xArray, uArray, yArray, icArray, aMat, bMat, cMat, dMat)
Create an LSE object in the database
Returns: Adams_OBJECT - key to the LSE object
Parameters:
xArray - int Adams ID of the X array
uArray - int Adams ID of the U array
yArray - int Adams ID of the Y array
icArray - int Adams ID of the IC array
aMat - int Adams ID of the A matrix
bMat - int Adams ID of the B matrix
cMat - int Adams ID of the C matrix
dMat - int Adams ID of the D matrix
Adams_OBJECT CreateGSE(nIn, nOut, xArray, uArray, yArray, icArray, xxFlag, xuFlag, yxFlag, yuFlag, Parm,libFunc)
Create an LSE object in the database
Returns: Adams_OBJECT - key to the LSE object
Parameters:
nIn - int number of inputs to system
nOut - int number of system outputs
xArray - int Adams ID of the X array
uArray - int Adams ID of the U array
yArray - int Adams ID of the Y array
icArray - int Adams ID of the IC array
xxFlag - char U user function provided None other wise
xuFlag - char U user function provided None other wise
yxFlag - char U user function provided None other wise
yuFlag - char U user function provided None other wise
Parm - list user parameters or empty
libFunc - string user function lib::func names
Adams_OBJECT CreateGForce(const int iMarkId, const int jMarkId, const int rMarkId, const char* Fx, const char* Fy, const char* Fz, const char* Tx, const char* Ty, const char*Tz)
Create an GFORCE object in the database
Returns: Adams_OBJECT - key to the GFORCE object
Parameters:
iMarkId - int I marker Adams ID
jMarkId - int J marker Adams ID
rMarkId - int Ref marker Adams ID
Fx - string solver function for force in the X direction
FY - string solver function for force in the Y direction
Fz - string solver function for force in the Z direction
TX - string solver function for torque in the X axis
Ty - string solver function for torque in the Y axis
Tz - string solver function for torque in the Z axis
Adams_OBJECT ReadResultsFile(analysisName, fileName)
Read a results file
Returns: Adams_OBJECT - key to the results object
Parameters:
analysisName - string name for the analysis
filename- string name of the .res file
bool WriteResultsFile(analysisObject, filename)
Write a results file
Returns: boolean - true if file written successfully false otherwise
Parameters:
analysisObject - Adams_OBJECT key of the analysis to write filename - string name of the .res file
Adams_OBJECT CreateResultsVariable(analysisObject, variableName,comment1, comment2, data)
Create a results variable
Returns: Adams_OBJECT - key of the variable
Parameters:
analysisObject - Adams_OBJECT key of the analysis
variableName - string name of the new variable
comment1- string variable comment
comment2- string variable comment
data- list values to assign to variable
AvAPI_Matrix StateMatrix(smObject, which)
Get a matrix from a state matrix object
Returns: AvAPI_Matrix - the matrix
Parameters:
smObject - Adams_OBJECT key to the state matrix object
which - char matrix to get A, B, C, D
double StateMatrixTime(smObject)
Get the time from a state matrix object
Returns: double - simulation time the state matrix object was created
Parameters:
smObject - Adams_OBJECT key to the state matrix object
bool StateMatrixABCD(smObject)
Determine if a state matrix object has B, C, D matrix
Returns: Boolean - true if B, C, and D exist false otherwise
Parameters:
smObject - Adams_OBJECT key to the state matrix object <![endif]>int NodeID(Marker)
Get the objects Node ID of a marker
Returns: int - the id of the node
Parameters:
Marker - Adams_OBJECT database object to get the id fromlist DependList(Object)
Get a list of dependants for the given object
Returns: list - list of objects
Parameters:
Object - Adams_OBJECT to get the dependants from list ReferenceList(Object)
Get a list of objects that reference the given object
Returns: list - list of objects
Parameters:
Object - Adams_OBJECT to get the references from
list MKCList(results)
Get a list of MKC objects for the given results object
Returns: list - list of MKC objects
Parameters:
results - Adams_OBJECT results object to get the MKC from
list FlexList()
Get a list of parts in the model
Returns: list - list of keys
Parameters: None
Adams_OBJECT Marker(Id)
Get a marker key given the id
Returns: Adams_OBJECT
Parameters:
Id - Adams id of the marker
Adams_OBJECT FixedJointMarker(Fixed, IorJ)
Get a marker key of a fixed joint given I or J
Returns: Adams_OBJECT
Parameters:
Fixed - key to the fixed joint
IorJ - character 'I' marker or 'J' marker
Adams_OBJECT GForceMarker(GF, IorJ)
Get a marker key of a GFORCE given I or J
Returns: Adams_OBJECT
Parameters:
GF - key to the GFORCE
IorJ - character 'I' marker or 'J' marker
void Delete(k_obj)
Delete an object from the database
Returns: None
Parameters:
k_obj - key to the object to be removed
list MarkerLocationOrientation(Marker, Analysis);
Returns the location and orientation of a marker
Returns: a six long list [X, Y, Z, Ax, Ay, Az]
Parameters:
Marker - Adams_OBJECT marker to get information for Analysis - Adams_OBJECT non- zero Analysis will return the current information zero Analysis will return the initial information
void ForceOnElement(k_obj, Analysis)
Returns the force action on the object
Returns: a six long list [FX, FY, FZ, Tx, Ty, Tz]
Parameters:
k_obj - Adams_OBJECT key to the object Analysis - Adams_OBJECT Analysis to return the forces from
AvAPI_Matrix MKC(k_obj, which)
Get a matrix from a MKC object
Returns: AvAPI_Matrix - the matrix
Parameters:
k_obj - Adams_OBJECT key to the MKC object which - char matrix to get M, K, C (B)
Adams_OBJECT CreateFixedJoint(iMark, jMark)
Create a fixed joint between the given markers
Returns: Adams_OBJECT - key to the fixed joint
Parameters:
iMark - Adams id of the I marker
jMark - Adams id of the J marker
Adams_OBJECT CreateAnalysis(model, name)
Create an analysis object
Returns: Adams_OBJECT - key to the analysis
Parameters:
model - Adams_OBJECT key to the model
mane - string name of the analysis
char* UnitString(unit)
Get the unit string for the given unit
Returns: string - unit string
Parameters:
unit - eUNIT any of the following
enum eUNIT
{
eNONE,
eANGLE,
eFORCE,
eFREQUENCY,
eLENGTH,
eMASS,
eTIME,
eINERTIA,
eVELOCITY,
eACCELERATION,
eANGULAR_VEL,
eANGULAR_ACCEL,
eSTIFFNESS,
eDAMPING,
eTORSION_STIFF,
eTORSION_DAMP,
eAREA,
eVOLUME,
eTORQUE,
ePRESSURE,
eAREA_INERTIA,
eDENSITY,
eENERGY,
eFORCE_TIME,
eTORQUE_TIME,
eFLOWRATE_PRESSURE_D,
eFLOW_RATE,
eF_PER_ANG,
eC_PER_ANG,
eCOMPOSED
}