mirror of
https://gitlab.com/scemama/QCaml.git
synced 2024-08-30 00:03:42 +02:00
52 lines
1.4 KiB
OCaml
52 lines
1.4 KiB
OCaml
(** A datastructure to represent pairs of atomic shells.
|
|
*)
|
|
|
|
type t
|
|
|
|
|
|
val make : ?cutoff:float -> AtomicShell.t -> AtomicShell.t -> t option
|
|
(** Creates an atomic shell pair from two atomic shells.
|
|
|
|
The contracted shell pairs contains the only pairs of primitives for which
|
|
the norm is greater than [cutoff].
|
|
|
|
If all the contracted shell pairs are not significant, the function returns
|
|
[None].
|
|
*)
|
|
|
|
val of_atomic_shell_array : AtomicShell.t array -> t option list
|
|
(** Creates all possible atomic shell pairs from an array of atomic shells.
|
|
If an atomic shell pair is not significant, sets the value to [None].
|
|
*)
|
|
|
|
val atomic_shell_a : t -> AtomicShell.t
|
|
(** Returns the first {!AtomicShell.t} which was used to build the atomic
|
|
shell pair.
|
|
*)
|
|
|
|
val atomic_shell_b : t -> AtomicShell.t
|
|
(** Returns the second {!AtomicShell.t} which was used to build the atomic
|
|
shell pair.
|
|
*)
|
|
|
|
val contracted_shell_pairs : t -> ContractedShellPair.t list
|
|
(** Returns an array of {!ContractedShellPair.t}, containing all the pairs of
|
|
contracted functions used to build the atomic shell pair.
|
|
*)
|
|
|
|
val center_ab : t -> Coordinate.t
|
|
(* A-B *)
|
|
|
|
val norm_sq : t -> float
|
|
(* |A-B|^2 *)
|
|
|
|
val norm_scales : t -> float array
|
|
(* norm_coef.(i) / norm_coef.(0) *)
|
|
|
|
val totAngMom : t -> AngularMomentum.t
|
|
(* Total angular Momentum *)
|
|
|
|
val monocentric : t -> bool
|
|
(** If true, the two atomic shells have the same center. *)
|
|
|