add_model_collection#

Cubic.add_model_collection(models, domain='all', regen_mode='deferred')#

Add a collection of several models at once

Parameters:
  • models (dict) – The collection of models to add.

  • regen_mode (str) – By default the models are not regenerated upon addition. See the docstring for add_model for more information.

  • domain (str) – The label indicating which locations the supplied collection of models should be applied to.

Notes

Collections are dictionaries that are formatted the same as obj.models. Several model collections are available in openpnm.models.collections.