Abstraction of a method from the ScaFaCoS library. More...

#include <Scafacos.hpp>

Inheritance diagram for Scafacos::Scafacos:

Public Member Functions
	Scafacos (MPI_Comm comm, std::string method, std::string parameters)

	~Scafacos ()

std::string	get_parameters () const
	Get the parameters from the library.

std::string	get_method () const
	Get active method name.

void	set_runtime_parameters (double const box_l, int const periodicity, int total_particles, int near_field_flag)
	Set box geometry, number of particles and calculation type.

Static Public Member Functions
static std::vector< std::string >	available_methods ()
	Get a list of methods supported by the library.

Protected Attributes
FCS	m_handle
	Handle from the library.

Detailed Description

Abstraction of a method from the ScaFaCoS library.

Definition at line 34 of file Scafacos.hpp.

Constructor & Destructor Documentation

◆ Scafacos()

Scafacos::Scafacos::Scafacos	(	MPI_Comm	comm,
		std::string	method,
		std::string	parameters
	)

Definition at line 73 of file Scafacos.cpp.

References handle_error.

◆ ~Scafacos()

Scafacos::Scafacos::~Scafacos ( )

Definition at line 83 of file Scafacos.cpp.

Member Function Documentation

◆ available_methods()

std::vector< std::string > Scafacos::Scafacos::available_methods ( )

static

Get a list of methods supported by the library.

Definition at line 30 of file Scafacos.cpp.

◆ get_method()

std::string Scafacos::Scafacos::get_method ( ) const

inline

Get active method name.

Definition at line 40 of file Scafacos.hpp.

Referenced by Scafacos::Coulomb::set_near_field_delegation().

◆ get_parameters()

std::string Scafacos::Scafacos::get_parameters ( ) const

inline

Get the parameters from the library.

Definition at line 38 of file Scafacos.hpp.

◆ set_runtime_parameters()

void Scafacos::Scafacos::set_runtime_parameters	(	double const *	box_l,
		int const *	periodicity,
		int	total_particles,
		int	near_field_flag
	)

Set box geometry, number of particles and calculation type.

Definition at line 85 of file Scafacos.cpp.

References handle_error.

Referenced by Scafacos::Coulomb::set_runtime_parameters().

Member Data Documentation

◆ m_handle

FCS Scafacos::Scafacos::m_handle

protected

Handle from the library.

Definition at line 51 of file Scafacos.hpp.

Referenced by Scafacos::Coulomb::Coulomb(), Scafacos::Coulomb::pair_energy(), Scafacos::Coulomb::pair_force(), Scafacos::Coulomb::r_cut(), Scafacos::Coulomb::run(), Scafacos::Coulomb::set_near_field_delegation(), Scafacos::Coulomb::set_r_cut(), and Scafacos::Coulomb::tune().

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

Public Member Functions

Static Public Member Functions

Protected Attributes