Minor docstring update

tacs/problems/base.py

@@ -100,7 +100,7 @@ def _addLoadToComponents(self, FVec, compIDs, F, averageLoad=False):
         Parameters
         ----------
 
-        FVec : TACS.Vec
+        FVec : tacs.TACS.Vec
             TACS BVec to add loads to.
 
         compIDs : list[int] or int
@@ -193,7 +193,7 @@ def _addLoadToNodes(self, FVec, nodeIDs, F, nastranOrdering=False):
         Parameters
         ----------
 
-        FVec : TACS.Vec
+        FVec : tacs.TACS.Vec
             TACS BVec to add loads to.
 
         nodeIDs : list[int]
@@ -309,7 +309,7 @@ def _addLoadToRHS(self, Frhs, Fapplied):
         Parameters
         ----------
 
-        Fapplied : numpy.ndarray or TACS.Vec
+        Fapplied : numpy.ndarray or tacs.TACS.Vec
             Distributed array containing loads to applied to RHS of the problem.
 
         """
@@ -699,7 +699,7 @@ def _addLoadFromBDF(self, FVec, auxElems, loadID, setScale=1.0):
         Parameters
         ----------
 
-        FVec : TACS.Vec
+        FVec : tacs.TACS.Vec
             TACS BVec to add loads to.
 
         auxElems : TACS AuxElements object

tacs/problems/modal.py

@@ -247,7 +247,7 @@ def addFunction(self, funcName, funcHandle, compIDs=None, **kwargs):
     def evalFunctions(self, funcs, evalFuncs=None, ignoreMissing=False):
         """
         Evaluate eigenvalues for problem. The functions corresponding to
-        the integers in EVAL_FUNCS are evaluated and updated into
+        the integers in evalFuncs are evaluated and updated into
         the provided dictionary.
 
         Parameters
@@ -301,7 +301,7 @@ def evalFunctionsSens(self, funcsSens, evalFuncs=None):
         """
         This is the main routine for returning useful (sensitivity)
         information from problem. The derivatives of the functions
-        corresponding to the strings in EVAL_FUNCS are evaluated and
+        corresponding to the strings in evalFuncs are evaluated and
         updated into the provided dictionary. The derivitives with
         respect to all design variables and node locations are computed.
 
@@ -427,7 +427,7 @@ def getVariables(self, index, states=None):
         index : int
             Mode index to return solution for.
 
-        states : TACS.Vec or numpy.ndarray or None
+        states : tacs.TACS.Vec or numpy.ndarray or None
             Place eigenvector for mode into this array (optional).
 
         Returns

tacs/problems/static.py

@@ -387,7 +387,7 @@ def setDesignVars(self, x):
 
         Parameters
         ----------
-        x : numpy.ndarray
+        x : numpy.ndarray or dict or tacs.TACS.Vec
             The variables (typically from the optimizer) to set. It
             looks for variable in the ``self.varName`` attribute.
 
@@ -515,7 +515,7 @@ def addLoadToRHS(self, Fapplied):
         Parameters
         ----------
 
-        Fapplied : numpy.ndarray or TACS.Vec
+        Fapplied : numpy.ndarray or tacs.TACS.Vec
             Distributed array containing loads to applied to RHS of the problem.
 
         """
@@ -735,7 +735,7 @@ def solve(self, Fext=None):
         ----------
         Optional Arguments:
 
-        Fext : numpy.ndarray or TACS.Vec
+        Fext : numpy.ndarray or tacs.TACS.Vec
             Distributed array containing additional loads (ex. aerodynamic forces for aerostructural coupling)
             to applied to RHS of the static problem.
 
@@ -841,7 +841,7 @@ def evalFunctions(self, funcs, evalFuncs=None, ignoreMissing=False):
         """
         This is the main routine for returning useful information from
         pytacs. The functions corresponding to the strings in
-        EVAL_FUNCS are evaluated and updated into the provided
+        evalFuncs are evaluated and updated into the provided
         dictionary.
 
         Parameters
@@ -930,7 +930,7 @@ def evalFunctionsSens(self, funcsSens, evalFuncs=None):
         """
         This is the main routine for returning useful (sensitivity)
         information from problem. The derivatives of the functions
-        corresponding to the strings in EVAL_FUNCS are evaluated and
+        corresponding to the strings in evalFuncs are evaluated and
         updated into the provided dictionary. The derivitives with
         respect to all design variables and node locations are computed.
 
@@ -1069,7 +1069,7 @@ def addSVSens(self, evalFuncs, svSensList):
         evalFuncs : list[str]
             The functions the user wants returned
 
-        svSensList : list[TACS.Vec] or list[numpy.ndarray]
+        svSensList : list[tacs.TACS.Vec] or list[numpy.ndarray]
             List of sensitivity vectors to add partial sensitivity to
         """
         # Set problem vars to assembler
@@ -1470,7 +1470,7 @@ def getVariables(self, states=None):
 
         Parameters
         ----------
-        states : TACS.Vec or numpy.ndarray
+        states : tacs.TACS.Vec or numpy.ndarray
             Vector to place current state variables into (optional)
 
         Returns

tacs/problems/transient.py

@@ -491,7 +491,7 @@ def addLoadToRHS(self, timeStep, Fapplied, timeStage=None):
         timeStep : int
             Time step index to apply load to.
 
-        Fapplied : numpy.ndarray or TACS.Vec
+        Fapplied : numpy.ndarray or tacs.TACS.Vec
             Distributed array containing loads to applied to RHS of the problem.
 
         timeStage : int or None
@@ -819,11 +819,11 @@ def setInitConditions(self, vars=None, dvars=None, ddvars=None):
 
         Parameters
         ----------
-        vars : float or numpy.ndarray or TACS.Vec
+        vars : float or numpy.ndarray or tacs.TACS.Vec
             Initial conditions of the state variables
-        dvars : float or numpy.ndarray or TACS.Vec
+        dvars : float or numpy.ndarray or tacs.TACS.Vec
             Initial conditions of the first time-derivative of the state variables
-        ddvars : float or numpy.ndarray or TACS.Vec
+        ddvars : float or numpy.ndarray or tacs.TACS.Vec
             Initial conditions of the second time-derivative of the state variables
         """
 
@@ -962,7 +962,7 @@ def iterate(self, timeStep, timeStage=None, Fext=None):
         timeStage : int or None
             Time stage index to iterate. If not None, solver must be multistage
 
-        Fext : TACS.Vec or numpy.ndarray or None
+        Fext : tacs.TACS.Vec or numpy.ndarray or None
             If Fext is not None, add this force vector to the loads applied at
             this time instance. Fext must be sized such that the flattened array
             is (numOwnedNodes*numVarsPerNode) in length. Useful for applying
@@ -1055,7 +1055,7 @@ def evalFunctions(self, funcs, evalFuncs=None, ignoreMissing=False):
         """
         This is the main routine for returning useful information from
         pytacs. The functions corresponding to the strings in
-        EVAL_FUNCS are evaluated and updated into the provided
+        evalFuncs are evaluated and updated into the provided
         dictionary.
 
         Parameters
@@ -1144,7 +1144,7 @@ def evalFunctionsSens(self, funcsSens, evalFuncs=None):
         """
         This is the main routine for returning useful (sensitivity)
         information from problem. The derivatives of the functions
-        corresponding to the strings in EVAL_FUNCS are evaluated and
+        corresponding to the strings in evalFuncs are evaluated and
         updated into the provided dictionary. The derivitives with
         respect to all design variables and node locations are computed.
 
@@ -1245,27 +1245,27 @@ def getVariables(
         timeStage : int or None
             Time stage index to get state variables for.
 
-        states : TACS.Vec or numpy.ndarray or None
+        states : tacs.TACS.Vec or numpy.ndarray or None
             If states is not None, place the state variables into this array (optional).
 
-        dstates : TACS.Vec or numpy.ndarray or None
+        dstates : tacs.TACS.Vec or numpy.ndarray or None
             If dstates is not None, place the time derivative of the state variables into this array (optional).
 
-        ddstates : TACS.Vec or numpy.ndarray or None
+        ddstates : tacs.TACS.Vec or numpy.ndarray or None
             If ddstates is not None, place the second time derivative of the state variables into this array (optional).
 
         Returns
         --------
         time: float
             The time at specified time instance
 
-        states : TACS.Vec or numpy.ndarray
+        states : tacs.TACS.Vec or numpy.ndarray
             The state variables.
 
-        dstates : TACS.Vec or numpy.ndarray or None
+        dstates : tacs.TACS.Vec or numpy.ndarray or None
             The time derivative of the state variables.
 
-        ddstates : TACS.Vec or numpy.ndarray or None
+        ddstates : tacs.TACS.Vec or numpy.ndarray or None
             The second time derivative of the state variables.
 
         """

tacs/pymeshloader.py

@@ -400,7 +400,7 @@ def getGlobalNodeIDsForComps(self, componentIDs, nastranOrdering=False):
         componentIDs : int or list[int]
             List of integers of the compIDs numbers.
 
-        nastranOrdering : False
+        nastranOrdering : bool
             Flag signaling whether nodeIDs are in TACS (default) or NASTRAN (grid IDs in bdf file) ordering
             Defaults to False.
 
@@ -438,7 +438,7 @@ def getLocalNodeIDsForComps(self, componentIDs):
 
         Returns
         -------
-        nodeIDs : list
+        nodeIDs : list[int]
             List of unique nodeIDs that belong to the given list of compIDs
         """
         # Get the global nodes for this component (TACS ordering)