10
1
mirror of https://gitlab.com/scemama/QCaml.git synced 2024-12-26 22:33:36 +01:00
QCaml/Basis/Basis.mli
2018-03-20 15:16:24 +01:00

37 lines
1.1 KiB
OCaml

(** The atomic basis set is represented as an array of {!ContractedShell.t}. *)
type t
val of_nuclei_and_general_basis : Nuclei.t -> GeneralBasis.t -> t
(** Takes an array of {!Nuclei.t}, and a {!GeneralBasis.t} (such as cc-pVDZ
for instance) and creates the corresponding atomic basis set.
All the {!Element.t}'s of the array of {!Nuclei.t} are searched in
the {!GeneralBasis.t}, and the basis is built by creating
{!ContractedShell.t}'s centered on the nuclei with the exponents
and contraction coefficients given by the {!GeneralBasis.t}.
*)
val of_nuclei_and_basis_filename : nuclei:Nuclei.t -> string -> t
(** Same as {!of_nuclei_and_general_basis}, but taking the {!GeneralBasis.t}
from a file.
*)
val size : t -> int
(** Number of contracted basis functions. *)
val atomic_shells : t -> AtomicShell.t array
(** Returns the contracted basis functions per atom. *)
val contracted_shells : t -> ContractedShell.t array
(** Returns all the contracted basis functions. *)
(** {2 Printers} *)
val to_string : t -> string
(** Pretty prints the basis set in a string. TODO *)