ECPPotential

pydantic model qcelemental.models.v2.ECPPotential

Information for a single ECP potential.

Show JSON schema

{
   "title": "ECPPotential",
   "description": "Information for a single ECP potential.",
   "type": "object",
   "properties": {
      "ecp_type": {
         "$ref": "#/$defs/ECPType"
      },
      "angular_momentum": {
         "description": "Angular momentum for the potential as an array of integers.",
         "items": {
            "minimum": 0,
            "type": "integer"
         },
         "minItems": 1,
         "title": "Angular Momentum",
         "type": "array",
         "uniqueItems": true
      },
      "r_exponents": {
         "description": "Exponents of the 'r' term.",
         "items": {
            "type": "integer"
         },
         "minItems": 1,
         "title": "R Exponents",
         "type": "array"
      },
      "gaussian_exponents": {
         "description": "Exponents of the 'gaussian' term.",
         "items": {
            "anyOf": [
               {
                  "type": "number"
               },
               {
                  "type": "string"
               }
            ]
         },
         "minItems": 1,
         "title": "Gaussian Exponents",
         "type": "array"
      },
      "coefficients": {
         "description": "General contraction coefficients for the potential; individual list components will be the individual segment contraction coefficients.",
         "items": {
            "items": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "type": "array"
         },
         "minItems": 1,
         "title": "Coefficients",
         "type": "array"
      }
   },
   "$defs": {
      "ECPType": {
         "description": "The type of the ECP potential.",
         "enum": [
            "scalar",
            "spinorbit"
         ],
         "title": "ECPType",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "ecp_type",
      "angular_momentum",
      "r_exponents",
      "gaussian_exponents",
      "coefficients"
   ]
}

Fields:

• angular_momentum (List[int])

• coefficients (List[List[float]])

• ecp_type (qcelemental.models.v2.basis_set.ECPType)

• gaussian_exponents (List[float])

• r_exponents (List[int])

Validators:

• _check_coefficient_length » coefficients

• _check_gaussian_exponents_length » gaussian_exponents

field angular_momentum: List[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]] [Required]

Angular momentum for the potential as an array of integers.

Constraints:

• min_length = 1

field coefficients: List[List[float]] [Required]

General contraction coefficients for the potential; individual list components will be the individual segment contraction coefficients.

Constraints:

• min_length = 1

Validated by:

• _check_coefficient_length

field ecp_type: ECPType [Required]

The type of the ECP potential.

field gaussian_exponents: List[float] [Required]

Exponents of the ‘gaussian’ term.

Constraints:

• min_length = 1

Validated by:

• _check_gaussian_exponents_length

field r_exponents: List[int] [Required]

Exponents of the ‘r’ term.

Constraints:

• min_length = 1