ForcesDoc

class emmet.core.molecules.trajectory.ForcesDoc(**data)

Bases: PropertyDoc

Parameters:

  • charge (int | None)

  • spin_multiplicity (int | None)

  • natoms (int | None)

  • elements (list[Annotated[ElementTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.element_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.element_adapter.<lambda>, return_type=str, when_used=always)]] | None)

  • nelements (int | None)

  • nelectrons (int | None)

  • composition (Annotated[CompositionTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, return_type=dict[str, float], when_used=always)] | None)

  • composition_reduced (Annotated[CompositionTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, return_type=dict[str, float], when_used=always)] | None)

  • formula_alphabetical (str | None)

  • formula_pretty (str | None)

  • formula_anonymous (str | None)

  • chemsys (str | None)

  • symmetry (PointGroupData | None)

  • species_hash (str | None)

  • coord_hash (str | None)

  • property_name (str)

  • property_id (str)

  • molecule_id (MPculeID)

  • deprecated (bool)

  • deprecation_reasons (list[str] | None)

  • level_of_theory (LevelOfTheory | None)

  • solvent (str | None)

  • lot_solvent (str | None)

  • last_updated (datetime)

  • origins (list[MolPropertyOrigin])

  • warnings (list[str])

  • forces (list[list[float]])

  • precise_forces (list[list[float] | None])

  • pcm_forces (list[list[float]] | None)

  • cds_forces (list[list[float]] | None)

  • average_force_magnitude (float | None)

  • max_force_magnitude (float | None)

  • min_force_magnitude (float | None)

classmethod from_task(task, molecule_id, deprecated=False, **kwargs)

Construct a force document from a task document

Parameters:

  • task (TaskDocument) – document from which force properties can be extracted

  • molecule_id (MPculeID) – MPculeID

  • deprecated (bool) – bool. Is this document deprecated?

  • kwargs – to pass to PropertyDoc

Returns:

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].