deepmd.dpmodel.model.polar_model
================================

.. py:module:: deepmd.dpmodel.model.polar_model


Attributes
----------

.. autoapisummary::

   deepmd.dpmodel.model.polar_model.DPPolarModel_


Classes
-------

.. autoapisummary::

   deepmd.dpmodel.model.polar_model.PolarModel


Module Contents
---------------

.. py:data:: DPPolarModel_

.. py:class:: PolarModel(*args: Any, **kwargs: Any)

   Bases: :py:obj:`deepmd.dpmodel.model.dp_model.DPModelCommon`, :py:obj:`DPPolarModel_`


   
   Common methods for DP models.

   This class provides common functionality for DeepPot models, including
   neighbor selection updates and fitting network access.















   ..
       !! processed by numpydoc !!

   .. py:method:: call(coord: deepmd.dpmodel.array_api.Array, atype: deepmd.dpmodel.array_api.Array, box: deepmd.dpmodel.array_api.Array | None = None, fparam: deepmd.dpmodel.array_api.Array | None = None, aparam: deepmd.dpmodel.array_api.Array | None = None, do_atomic_virial: bool = False, charge_spin: deepmd.dpmodel.array_api.Array | None = None) -> dict[str, deepmd.dpmodel.array_api.Array]


   .. py:method:: call_lower(extended_coord: deepmd.dpmodel.array_api.Array, extended_atype: deepmd.dpmodel.array_api.Array, nlist: deepmd.dpmodel.array_api.Array, mapping: deepmd.dpmodel.array_api.Array | None = None, fparam: deepmd.dpmodel.array_api.Array | None = None, aparam: deepmd.dpmodel.array_api.Array | None = None, do_atomic_virial: bool = False, charge_spin: deepmd.dpmodel.array_api.Array | None = None) -> dict[str, deepmd.dpmodel.array_api.Array]


   .. py:method:: translated_output_def() -> dict[str, Any]