Source code for openmdao.components.paramcomp

""" OpenMDAO class definition for ParamComp"""

import collections
from six import string_types

from openmdao.core.component import Component


class ParamComp(Component):
    """A Component that provides an output to connect to a parameter."""

    def __init__(self, name, val=None, **kwargs):
        super(ParamComp, self).__init__()

        if isinstance(name, string_types):
            if val is None:
                raise ValueError('ParamComp init: a value must be provided as the second arg.')
            self.add_output(name, val, **kwargs)

        elif isinstance(name, collections.Iterable):
            for tup in name:
                badtup = None
                if isinstance(tup, tuple):
                    if len(tup) == 3:
                        n, v, kw = tup
                    elif len(tup) == 2:
                        n, v = tup
                        kw = {}
                    else:
                        badtup = tup
                else:
                    badtup = tup
                if badtup:
                    if isinstance(badtup, string_types):
                        badtup = name
                    raise ValueError("ParamComp init: arg %s must be a tuple of the form "
                                     "(name, value) or (name, value, keyword_dict)." %
                                     str(badtup))
                self.add_output(n, v, **kw)
        else:
            raise ValueError("first argument to ParamComp init must be either of type "
                             "`str` or an iterable of tuples of the form (name, value) or "
                             "(name, value, keyword_dict).")

    def apply_linear(self, mode, ls_inputs=None, vois=(None, )):
        """For `ParamComp`, just pass on the incoming values.

        Args
        ----
        mode : string
            Derivative mode, can be 'fwd' or 'rev'.

        ls_inputs : dict
            We can only solve derivatives for the inputs the instigating
            system has access to. (Not used here.)

        vois: list of strings
            List of all quantities of interest to key into the mats.
        """
        if mode == 'fwd':
            sol_vec, rhs_vec = self.dumat, self.drmat
        else:
            sol_vec, rhs_vec = self.drmat, self.dumat

        for voi in vois:
            rhs_vec[voi].vec[:] += sol_vec[voi].vec[:]

    def solve_nonlinear(self, params, unknowns, resids):
        """ Performs no operation. """
        pass