gmx::IFmmOptions Struct Reference

#include <gromacs/fmm/fmmoptions.h>

Inherited by gmx::ExaFmmOptions, and gmx::FMSolvrOptions.

Description

Interface for FMM option sets used in MDP handling.

This interface ensures that all FMM backend option types (e.g., ExaFMM, FMSolvr) provide consistent implementations of the three MDP-related methods:

• initMdpOptionsFmm(): declares MDP options
• initMdpTransformFmm(): sets up option transformations
• buildMdpOutputFmm(): outputs values to the MDP file

These methods follow the same structure as IMdpOptionProvider, but IFmmOptions does not inherit from it because:

• Each FMM backend (e.g., ExaFMM, FMSolvr) is part of a larger option group, not a standalone MDP option provider.
• Only FmmMdpOptions is registered as the provider and delegates to the backends.

This keeps the logic for each backend modular while centralizing integration.

Public Member Functions
virtual void	initMdpOptionsFmm (OptionSectionHandle &section)=0
virtual void	initMdpTransformFmm (IKeyValueTreeTransformRules *rules)=0
virtual void	buildMdpOutputFmm (KeyValueTreeObjectBuilder *builder) const =0
virtual void	validateMdpOptions (WarningHandler *wi) const =0
	GMX_DEFAULT_CONSTRUCTORS (IFmmOptions)

---

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

• src/gromacs/fmm/fmmoptions.h