MADNESS 0.10.1
madness::MolecularOrbitals< T, NDIM > Class Template Reference

#include <MolecularOrbitals.h>

Inheritance diagram for madness::MolecularOrbitals< T, NDIM >:
Collaboration diagram for madness::MolecularOrbitals< T, NDIM >:

Public Member Functions

 MolecularOrbitals ()=default
 MolecularOrbitals (const MolecularOrbitals< T, NDIM > &other)=default
 MolecularOrbitals (const std::vector< Function< T, NDIM > > &mo)
 MolecularOrbitals (const std::vector< Function< T, NDIM > > &mo, const Tensor< double > &eps)
 MolecularOrbitals (const std::vector< Function< T, NDIM > > &mo, const Tensor< double > &eps, const std::vector< std::string > &irrep, const Tensor< double > &occ, const std::vector< int > &set)
std::vector< Vector< typename Tensor< T >::scalar_type, 3 > > compute_center (const Function< typename Tensor< T >::scalar_type, NDIM > metric2=Function< typename Tensor< T >::scalar_type, NDIM >()) const
Tensor< double > get_eps () const
std::vector< std::string > get_irreps () const
std::vector< int > get_localize_sets () const
std::vector< Function< T, NDIM > > get_mos () const
Tensor< double > get_occ () const
MolecularOrbitals get_subset (const int iset) const
void invalidate_all ()
void invalidate_eps ()
void invalidate_irreps ()
void invalidate_localize_sets ()
void invalidate_mos ()
void invalidate_occ ()
void load_mos (archive::ParallelInputArchive<> &ar, const Molecule &molecule, const std::size_t nmo_from_input, const bool allow_fewer=false)
void post_process_mos (World &world, const double thresh, const int k)
void pretty_print (std::string message, std::vector< std::string > flags=std::vector< std::string >()) const
void print_cubefiles (const std::string name, const std::vector< std::string > cubefile_header) const
void print_frozen_orbitals (const long freeze) const
void project_ao (World &world, const Tensor< T > &Saomo, const std::vector< Function< double, 3 > > &aos)
MolecularOrbitals & recompute_irreps (const std::string pointgroup, const Function< typename Tensor< T >::scalar_type, NDIM > &metric)
MolecularOrbitals & recompute_localize_sets (const double bandwidth=1.5)
 group orbitals into sets of similar orbital energies for localization
void save_mos (archive::ParallelOutputArchive<> &ar, const Molecule &molecule) const
 legacy code
template<typename Archive>
void serialize (Archive &ar)
MolecularOrbitals & set_all_orbitals_occupied ()
MolecularOrbitals & set_mos (const std::vector< Function< T, NDIM > > &mo_new)
 setters will always invalidate all other member variables
std::size_t size () const
MolecularOrbitals & update_localize_set (const std::vector< int > &set)
 updates will keep other member variables
MolecularOrbitals & update_mos (const std::vector< Function< T, NDIM > > &mo_new)
 updates will keep other member variables
MolecularOrbitals & update_mos_and_eps (const std::vector< Function< T, NDIM > > &mo_new, const Tensor< double > &eps_new)
 updates will keep other member variables
MolecularOrbitals & update_occ (const Tensor< double > &occ_new)
void write_to (std::vector< Function< T, NDIM > > &mo_out, Tensor< double > &eps_out, std::vector< std::string > &irrep_out, Tensor< double > &occ_out, std::vector< int > &set_out) const

Static Public Member Functions

static std::vector< Slice > convert_set_to_slice (const std::vector< int > &localized_set)
static std::pair< MolecularOrbitals< T, NDIM >, MolecularOrbitals< T, NDIM > > read_restartaodata (World &world, const Molecule &molecule, const bool have_beta)
 uses AO-projection as a restart guess
static std::pair< MolecularOrbitals< T, NDIM >, MolecularOrbitals< T, NDIM > > read_restartdata (World &world, const std::string filename, const Molecule &molecule, const std::size_t nmo_alpha, const std::size_t nmo_beta)
 reads amo and bmo from the restartdata file
static void save_restartaodata (World &world, const Molecule &molecule, const MolecularOrbitals< T, NDIM > &amo, const MolecularOrbitals< T, NDIM > &bmo, const AtomicBasisSet &aobasis)
 save MOs in the AO projection for geometry restart
static void save_restartdata (World &world, const std::string filename, const Molecule &molecule, const MolecularOrbitals< T, NDIM > &amo, const MolecularOrbitals< T, NDIM > &bmo)
 writes amo and bmo to a restartdata file

Private Attributes

Tensor< double > eps
std::vector< std::string > irreps
std::vector< int > localize_sets
std::vector< Function< T, NDIM > > mo
Tensor< double > occ

Friends

bool similar (const MolecularOrbitals &mo1, const MolecularOrbitals &mo2, const double thresh=1.e-6)

Constructor & Destructor Documentation

◆ MolecularOrbitals() [1/5]

◆ MolecularOrbitals() [2/5]

template<typename T, std::size_t NDIM>
madness::MolecularOrbitals< T, NDIM >::MolecularOrbitals ( )
default

◆ MolecularOrbitals() [3/5]

template<typename T, std::size_t NDIM>
madness::MolecularOrbitals< T, NDIM >::MolecularOrbitals ( const std::vector< Function< T, NDIM > > & mo)
inline

References eps, irreps, localize_sets, mo, and occ.

◆ MolecularOrbitals() [4/5]

template<typename T, std::size_t NDIM>
madness::MolecularOrbitals< T, NDIM >::MolecularOrbitals ( const std::vector< Function< T, NDIM > > & mo,
const Tensor< double > & eps )
inline

References eps, irreps, localize_sets, mo, and occ.

◆ MolecularOrbitals() [5/5]

template<typename T, std::size_t NDIM>
madness::MolecularOrbitals< T, NDIM >::MolecularOrbitals ( const std::vector< Function< T, NDIM > > & mo,
const Tensor< double > & eps,
const std::vector< std::string > & irrep,
const Tensor< double > & occ,
const std::vector< int > & set )
inline

References eps, irreps, localize_sets, mo, and occ.

Member Function Documentation

◆ compute_center()

◆ convert_set_to_slice()

◆ get_eps()

◆ get_irreps()

template<typename T, std::size_t NDIM>
std::vector< std::string > madness::MolecularOrbitals< T, NDIM >::get_irreps ( ) const
inlinenodiscard

References irreps.

Referenced by pretty_print().

◆ get_localize_sets()

◆ get_mos()

◆ get_occ()

template<typename T, std::size_t NDIM>
Tensor< double > madness::MolecularOrbitals< T, NDIM >::get_occ ( ) const
inline

◆ get_subset()

template<typename T, std::size_t NDIM>
MolecularOrbitals madness::MolecularOrbitals< T, NDIM >::get_subset ( const int iset) const
inline

◆ invalidate_all()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_all ( )
inline

◆ invalidate_eps()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_eps ( )
inline

References eps.

Referenced by invalidate_all().

◆ invalidate_irreps()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_irreps ( )
inline

References irreps.

Referenced by invalidate_all().

◆ invalidate_localize_sets()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_localize_sets ( )
inline

References localize_sets.

Referenced by invalidate_all().

◆ invalidate_mos()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_mos ( )
inline

References mo.

Referenced by invalidate_all().

◆ invalidate_occ()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::invalidate_occ ( )
inline

References occ.

Referenced by invalidate_all().

◆ load_mos()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::load_mos ( archive::ParallelInputArchive<> & ar,
const Molecule & molecule,
const std::size_t nmo_from_input,
const bool allow_fewer = false )
inline

legacy code

Parameters
[in]allow_fewerreturn the archive's orbitals when it holds fewer than requested (the caller pads); otherwise that is an error

References madness::copy(), eps, localize_sets, MADNESS_CHECK_THROW, mo, molecule, and occ.

Referenced by madness::SCF::load_mos(), and read_restartdata().

◆ post_process_mos()

◆ pretty_print()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::pretty_print ( std::string message,
std::vector< std::string > flags = std::vector<std::string>() ) const
inline

◆ print_cubefiles()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::print_cubefiles ( const std::string name,
const std::vector< std::string > cubefile_header ) const
Parameters
[in]cubefile_headerheader of the cube file, from molecule::cubefile_header()

References madness::cubefile_header(), madness::filename, get_mos(), madness::name(), madness::plot_cubefile(), and size().

◆ print_frozen_orbitals()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::print_frozen_orbitals ( const long freeze) const
inline

◆ project_ao()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::project_ao ( World & world,
const Tensor< T > & Saomo,
const std::vector< Function< double, 3 > > & aos )

◆ read_restartaodata()

template<typename T, std::size_t NDIM>
std::pair< MolecularOrbitals< T, NDIM >, MolecularOrbitals< T, NDIM > > madness::MolecularOrbitals< T, NDIM >::read_restartaodata ( World & world,
const Molecule & molecule,
const bool have_beta )
static

uses AO-projection as a restart guess

Returns
amo and bmo

References MolecularOrbitals(), aobasis, eps, molecule, occ, madness::print(), project_ao(), and madness::SCF::project_ao_basis_only().

Referenced by madness::Znemo::read_restartaodata(), and test_read_restartaodata().

◆ read_restartdata()

template<typename T, std::size_t NDIM>
std::pair< MolecularOrbitals< T, NDIM >, MolecularOrbitals< T, NDIM > > madness::MolecularOrbitals< T, NDIM >::read_restartdata ( World & world,
const std::string filename,
const Molecule & molecule,
const std::size_t nmo_alpha,
const std::size_t nmo_beta )
inlinestatic

◆ recompute_irreps()

template<typename T, std::size_t NDIM>
MolecularOrbitals< T, NDIM > & madness::MolecularOrbitals< T, NDIM >::recompute_irreps ( const std::string pointgroup,
const Function< typename Tensor< T >::scalar_type, NDIM > & metric )

◆ recompute_localize_sets()

◆ save_mos()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::save_mos ( archive::ParallelOutputArchive<> & ar,
const Molecule & molecule ) const
inline

legacy code

References eps, localize_sets, mo, molecule, and occ.

Referenced by save_restartdata().

◆ save_restartaodata()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::save_restartaodata ( World & world,
const Molecule & molecule,
const MolecularOrbitals< T, NDIM > & amo,
const MolecularOrbitals< T, NDIM > & bmo,
const AtomicBasisSet & aobasis )
static

save MOs in the AO projection for geometry restart

compute the aos in MRA projection as:

compute the aos in MRA projection as: std::vector<Function<double,3> > aos=SCF::project_ao_basis_only(world, calc.aobasis, calc.molecule);

References MolecularOrbitals(), aobasis, get_eps(), get_localize_sets(), get_mos(), get_occ(), madness::matrix_inner(), molecule, madness::SCF::project_ao_basis_only(), madness::World::rank(), madness::BaseTensor::size(), and size().

Referenced by madness::Znemo::save_orbitals(), and test_read_restartaodata().

◆ save_restartdata()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::save_restartdata ( World & world,
const std::string filename,
const Molecule & molecule,
const MolecularOrbitals< T, NDIM > & amo,
const MolecularOrbitals< T, NDIM > & bmo )
inlinestatic

writes amo and bmo to a restartdata file

The header is written through RestartMetadata, so an archive produced here is readable by SCF::load_mos. Most header fields describe an SCF this function does not have (energy, convergence, xc), so they keep their "unknown" defaults – a restart will treat these orbitals as a guess to iterate on rather than a converged answer, which is what they are.

References MolecularOrbitals(), madness::filename, madness::FunctionDefaults< NDIM >::get_k(), molecule, and save_mos().

◆ serialize()

template<typename T, std::size_t NDIM>
template<typename Archive>
void madness::MolecularOrbitals< T, NDIM >::serialize ( Archive & ar)
inline

References eps, irreps, localize_sets, m, mo, and occ.

◆ set_all_orbitals_occupied()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::set_all_orbitals_occupied ( )
inline

◆ set_mos()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::set_mos ( const std::vector< Function< T, NDIM > > & mo_new)
inline

setters will always invalidate all other member variables

References MolecularOrbitals(), invalidate_all(), and mo.

Referenced by madness::Znemo::custom_guess(), and madness::Znemo::read_explicit_guess_functions().

◆ size()

template<typename T, std::size_t NDIM>
std::size_t madness::MolecularOrbitals< T, NDIM >::size ( ) const
inline

References mo.

Referenced by print_cubefiles(), and save_restartaodata().

◆ update_localize_set()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::update_localize_set ( const std::vector< int > & set)
inline

updates will keep other member variables

References MolecularOrbitals(), and localize_sets.

Referenced by recompute_localize_sets().

◆ update_mos()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::update_mos ( const std::vector< Function< T, NDIM > > & mo_new)
inline

updates will keep other member variables

References MolecularOrbitals(), and mo.

Referenced by madness::Localizer::localize().

◆ update_mos_and_eps()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::update_mos_and_eps ( const std::vector< Function< T, NDIM > > & mo_new,
const Tensor< double > & eps_new )
inline

updates will keep other member variables

References MolecularOrbitals(), madness::copy(), eps, and mo.

Referenced by madness::Znemo::save_orbitals(), madness::OEP::save_restartdata(), test_ethylene(), and test_ne_boys().

◆ update_occ()

template<typename T, std::size_t NDIM>
MolecularOrbitals & madness::MolecularOrbitals< T, NDIM >::update_occ ( const Tensor< double > & occ_new)
inline

References MolecularOrbitals(), and occ.

Referenced by madness::OEP::save_restartdata().

◆ write_to()

template<typename T, std::size_t NDIM>
void madness::MolecularOrbitals< T, NDIM >::write_to ( std::vector< Function< T, NDIM > > & mo_out,
Tensor< double > & eps_out,
std::vector< std::string > & irrep_out,
Tensor< double > & occ_out,
std::vector< int > & set_out ) const

◆ similar

template<typename T, std::size_t NDIM>
bool similar ( const MolecularOrbitals< T, NDIM > & mo1,
const MolecularOrbitals< T, NDIM > & mo2,
const double thresh = 1.e-6 )
friend

Member Data Documentation

◆ eps

◆ irreps

template<typename T, std::size_t NDIM>
std::vector<std::string> madness::MolecularOrbitals< T, NDIM >::irreps
private

◆ localize_sets

◆ mo

◆ occ


The documentation for this class was generated from the following files: