add local_gradient to ComponentModeler

Author: tylerflex

tidy3d/plugins/smatrix/component_modelers/base.py

@@ -109,6 +109,14 @@ class AbstractComponentModeler(ABC, Tidy3dBaseModel):
         "fields that were not used to create the task will cause errors.",
     )
 
+    local_gradient: bool = pd.Field(
+        False,
+        title="Local Gradient",
+        description="Whether to run the gradient calculation locally. By default it is run through "
+        "the server to save data transfer. In some cases, such as debugging, it is useful to run "
+        "locally instead.",
+    )
+
     @pd.root_validator(pre=False)
     def _warn_deprecation_2_10(cls, values):
         log.warning(
@@ -219,7 +227,12 @@ def batch_data(self) -> BatchData:
                 "simulations",
             }
         )
-        return run_async(batch.simulations, **run_async_kwargs, path_dir=self.path_dir)
+        return run_async(
+            batch.simulations,
+            **run_async_kwargs,
+            local_gradient=self.local_gradient,
+            path_dir=self.path_dir,
+        )
 
     def get_path_dir(self, path_dir: str) -> None:
         """Check whether the supplied 'path_dir' matches the internal field value."""