Skip to content

Commit 5d3d56b

Browse files
gmalinvePipKat
andauthored
Apply suggestions from code review
Co-authored-by: Kathy Pippert <[email protected]>
1 parent 46e8c03 commit 5d3d56b

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

pyaedt/maxwell.py

+14-13
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ def apply_skew(
190190
def set_core_losses(self, objects, core_loss_on_field=False):
191191
"""Whether to enable core losses for a set of objects.
192192
193-
For ``EddyCurrent`` and ``Transient`` solver designs, core losses calulcations
193+
For ``EddyCurrent`` and ``Transient`` solver designs, core losses calculations
194194
may be included in the simulation on any object that has a corresponding
195195
core loss definition (with core loss coefficient settings) in the material library.
196196
@@ -611,7 +611,7 @@ def eddy_effects_on(self, objects, enable_eddy_effects=True, enable_displacement
611611

612612
@pyaedt_function_handler(windings_name="windings")
613613
def setup_y_connection(self, windings=None):
614-
"""Setup the Y connection.
614+
"""Set up the Y connection.
615615
616616
Parameters
617617
----------
@@ -1061,7 +1061,7 @@ def assign_winding(
10611061
resistance : float, optional
10621062
Resistance in ohms. The default is ``0``.
10631063
inductance : float, optional
1064-
Inductnace in Henry (H). The default is ``0``.
1064+
Inductance in Henry (H). The default is ``0``.
10651065
voltage : float, optional
10661066
Voltage value. The default is ``0``.
10671067
parallel_branches : int, optional
@@ -1291,7 +1291,7 @@ def assign_force(self, objects, coordinate_system="Global", is_virtual=True, for
12911291
self._boundaries[bound.name] = bound
12921292
return bound
12931293
else:
1294-
self.logger.error("Solution Type has not Matrix Parameter")
1294+
self.logger.error("Solution type has no 'Matrix' parameter.")
12951295
return False
12961296

12971297
@pyaedt_function_handler(input_object="objects", reference_cs="coordinate_system")
@@ -1880,7 +1880,7 @@ def export_element_based_harmonic_force(
18801880
Parameters
18811881
----------
18821882
output_directory : str, optional
1883-
The path for the output directory. If ``None`` pyaedt working dir will be used.
1883+
Path for the output directory. If ``None`` pyaedt working dir will be used.
18841884
setup : str, optional
18851885
Name of the solution setup. If ``None``, the nominal setup is used.
18861886
start_frequency : float, optional
@@ -1966,7 +1966,8 @@ def edit_external_circuit(self, netlist_file_path, schematic_design_name):
19661966
def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs):
19671967
"""Create an analysis setup for Maxwell 3D or 2D.
19681968
1969-
Optional arguments are passed along with ``setuptype`` and ``setupname``.
1969+
Optional arguments are passed using the ``setup_type`` and ``name``
1970+
parameters.
19701971
Keyword names correspond to the ``setuptype`` corresponding to the native AEDT API.
19711972
The list of keywords here is not exhaustive.
19721973
@@ -2148,7 +2149,7 @@ def assign_insulating(self, objects, insulation=None):
21482149
objects : str or int
21492150
Objects or faces to apply the insulating boundary to.
21502151
insulation : str, optional
2151-
Name of the insulation. The default is ``None`` in which case a unique name is chosen.
2152+
Name of the insulation. The default is ``None``, in which case a unique name is assigned.
21522153
21532154
Returns
21542155
-------
@@ -2225,7 +2226,7 @@ def assign_impedance(
22252226
If the option ``material_name`` is activated, the permeability can either be linear or not.
22262227
The default value is ``False``.
22272228
impedance : str, optional
2228-
Name of the impedance. The default is ``None`` in which case a unique name is chosen.
2229+
Name of the impedance. The default is ``None``, in which case a unique name is assigned.
22292230
22302231
Returns
22312232
-------
@@ -2567,13 +2568,13 @@ def assign_layout_force(
25672568
Parameters
25682569
----------
25692570
net_layers : dict
2570-
Each <layer, net> pair represents the object(s) in the intersection of corresponding layer and net.
2571-
Net name is dictionary's key, layers name is the list of layer names.
2571+
Each <layer, net> pair represents the objects in the intersection of the corresponding layer and net.
2572+
The layer name is from the list of layer names. The net name is the dictionary's key.
25722573
component_name : str
2573-
Name of the 3d component to assign the layout force to.
2574+
Name of the 3D component to assign the layout force to.
25742575
coordinate_system : str, optional
25752576
Reference coordinate system.
2576-
If not provided the global one will be set.
2577+
If not provided, the global one is used.
25772578
force_name : str, optional
25782579
Name of the layout force.
25792580
If not provided a random name will be generated.
@@ -2926,7 +2927,7 @@ def model_depth(self, value):
29262927

29272928
@pyaedt_function_handler(linefilter="line_filter", objectfilter="object_filter")
29282929
def generate_design_data(self, line_filter=None, object_filter=None):
2929-
"""Generate a generic set of design data and store it in the extension directory as ``design_data.json``.
2930+
"""Generate a generic set of design data and store it in the extension directory in a ``design_data.json`` file.
29302931
29312932
Parameters
29322933
----------

0 commit comments

Comments
 (0)