cavcalc.parameters.parameter.Parameter

Overview

class cavcalc.parameters.parameter.Parameter(name_or_ptype, value: ~typing.Optional[~pint.quantity.build_quantity_class.<locals>.Quantity] = None)

Bases: ABC

Abstract base class for cavity parameter instances.

Properties

Parameter.category	The ParameterCategory that this parameter belongs to.
Parameter.description	A brief description of the parameter type.
Parameter.has_angular_units	Whether the units of this parameter are of angular type.
Parameter.has_frequency_units	Whether the units of this parameter are of frequency type.
Parameter.has_length_units	Whether the units of this parameter are of length type..
Parameter.is_array	Whether the magnitude of the current value, if any, is array-like.
Parameter.is_scalar	Whether the magnitude of the current value, if any, is not array-like.
Parameter.is_unitless	Whether this parameter is a dimensionless type.
Parameter.name	The name of the parameter.
Parameter.ptype	The type of the parameter.
Parameter.symbol_str	A LaTeX style string representation of the parameter name.
Parameter.value	The current value of the parameter, as a pint Quantity.