#include <PoissonSolver.hpp>

Inheritance diagram for walberla::PoissonSolver:

Collaboration diagram for walberla::PoissonSolver:

Public Member Functions
	PoissonSolver (std::shared_ptr< LatticeWalberla > lattice, double permittivity)

	~PoissonSolver () override=default

virtual void	reset_charge_field ()=0

virtual void	add_charge_to_field (std::size_t id, double valency)=0

virtual std::size_t	get_potential_field_id () const noexcept=0

virtual void	set_permittivity (double permittivity) noexcept

virtual double	get_permittivity () const noexcept

LatticeWalberla const &	get_lattice () const noexcept override

virtual void	solve ()=0

virtual std::optional< double >	get_node_potential (Utils::Vector3i const &node, bool consider_ghosts=false)=0

virtual bool	set_node_potential (Utils::Vector3i const &node, double potential)=0

virtual std::vector< double >	get_slice_potential (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0

virtual void	set_slice_potential (Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &potential)=0

virtual void	ghost_communication ()=0

virtual void	setup_fft (bool use_gpu_aware)=0

virtual bool	is_gpu () const noexcept=0

virtual bool	is_double_precision () const noexcept=0

Public Member Functions inherited from LatticeModel
virtual	~LatticeModel ()=default

std::shared_ptr< VTKHandle >	create_vtk (int delta_N, int initial_count, int flag_observables, units_map const &units_conversion, std::string const &identifier, std::string const &base_folder, std::string const &prefix, bool force_pvtu, bool include_boundaries=false)
	Create a VTK observable.

void	write_vtk (std::string const &vtk_uid)
	Write a VTK observable to disk.

void	switch_vtk (std::string const &vtk_uid, bool status)
	Toggle a VTK observable on/off.

Protected Member Functions
void	register_vtk_field_filters (walberla::vtk::VTKOutput &) override

Protected Member Functions inherited from LatticeModel
virtual void	register_vtk_field_writers (walberla::vtk::VTKOutput &vtk_obj, units_map const &units_conversion, int flag_observables)=0
	Register VTK writers.

virtual void	integrate_vtk_writers ()=0

Additional Inherited Members
Public Types inherited from LatticeModel
using	units_map = std::unordered_map< std::string, double >

Protected Attributes inherited from LatticeModel
std::map< std::string, std::shared_ptr< VTKHandle > >	m_vtk_auto
	VTK writers that are executed automatically.

std::map< std::string, std::shared_ptr< VTKHandle > >	m_vtk_manual
	VTK writers that are executed manually.

Detailed Description

Definition at line 32 of file PoissonSolver.hpp.

Constructor & Destructor Documentation

◆ PoissonSolver()

walberla::PoissonSolver::PoissonSolver	(	std::shared_ptr< LatticeWalberla >	lattice,
		double	permittivity
	)

inline

Definition at line 38 of file PoissonSolver.hpp.

◆ ~PoissonSolver()

walberla::PoissonSolver::~PoissonSolver ( )

overridedefault

Member Function Documentation

◆ add_charge_to_field()

virtual void walberla::PoissonSolver::add_charge_to_field	(	std::size_t	id,
		double	valency
	)

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ get_lattice()

LatticeWalberla const & walberla::PoissonSolver::get_lattice ( ) const

inlineoverridevirtualnoexcept

Implements LatticeModel.

Definition at line 56 of file PoissonSolver.hpp.

◆ get_node_potential()

virtual std::optional< double > walberla::PoissonSolver::get_node_potential	(	Utils::Vector3i const &	node,
		bool	consider_ghosts = `false`
	)

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ get_permittivity()

virtual double walberla::PoissonSolver::get_permittivity ( ) const

inlinevirtualnoexcept

Definition at line 52 of file PoissonSolver.hpp.

Referenced by walberla::PoissonSolverFFT< FloatType, Architecture >::add_charge_to_field().

◆ get_potential_field_id()

virtual std::size_t walberla::PoissonSolver::get_potential_field_id ( ) const

pure virtualnoexcept

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ get_slice_potential()

virtual std::vector< double > walberla::PoissonSolver::get_slice_potential	(	Utils::Vector3i const &	lower_corner,
		Utils::Vector3i const &	upper_corner
	)		const

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

Referenced by ScriptInterface::walberla::EKPoissonSolverSlice::do_call_method().

◆ ghost_communication()

virtual void walberla::PoissonSolver::ghost_communication ( )

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ is_double_precision()

virtual bool walberla::PoissonSolver::is_double_precision ( ) const

pure virtualnoexcept

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ is_gpu()

virtual bool walberla::PoissonSolver::is_gpu ( ) const

pure virtualnoexcept

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ register_vtk_field_filters()

void walberla::PoissonSolver::register_vtk_field_filters ( walberla::vtk::VTKOutput & )

inlineoverrideprotectedvirtual

Implements LatticeModel.

Definition at line 82 of file PoissonSolver.hpp.

◆ reset_charge_field()

virtual void walberla::PoissonSolver::reset_charge_field ( )

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ set_node_potential()

virtual bool walberla::PoissonSolver::set_node_potential	(	Utils::Vector3i const &	node,
		double	potential
	)

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ set_permittivity()

virtual void walberla::PoissonSolver::set_permittivity ( double permittivity )

inlinevirtualnoexcept

Definition at line 48 of file PoissonSolver.hpp.

References stream.

◆ set_slice_potential()

virtual void walberla::PoissonSolver::set_slice_potential	(	Utils::Vector3i const &	lower_corner,
		Utils::Vector3i const &	upper_corner,
		std::vector< double > const &	potential
	)

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

Referenced by ScriptInterface::walberla::EKPoissonSolverSlice::do_call_method().

◆ setup_fft()

virtual void walberla::PoissonSolver::setup_fft ( bool use_gpu_aware )

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

◆ solve()

virtual void walberla::PoissonSolver::solve ( )

pure virtual

Implemented in walberla::PoissonSolverFFT< FloatType, Architecture >, and walberla::PoissonSolverNone< FloatType, Architecture >.

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

PoissonSolver.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PoissonSolver()

◆ ~PoissonSolver()

Member Function Documentation

◆ add_charge_to_field()

◆ get_lattice()

◆ get_node_potential()

◆ get_permittivity()

◆ get_potential_field_id()

◆ get_slice_potential()

◆ ghost_communication()

◆ is_double_precision()

◆ is_gpu()

◆ register_vtk_field_filters()

◆ reset_charge_field()

◆ set_node_potential()

◆ set_permittivity()

◆ set_slice_potential()

◆ setup_fft()

◆ solve()