Gromacs  2025-dev-20241003-bd59e46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::anonymous_namespace{electricfield.cpp}::ElectricFieldDimension Class Reference

Description

Describes an applied electric field in a coordinate dimension.

Can compute the applied field strength at a time, and supports operations to read and form corresponding .mdp contents.

Public Member Functions

void initMdpOptions (IOptionsContainerWithSections *options, const char *sectionName)
 Adds an option section to specify parameters for this field component.
 
void buildMdpOutput (KeyValueTreeObjectBuilder *builder, const std::string &name) const
 Creates mdp parameters for this field component.
 
real evaluate (real t) const
 Evaluates this field component at given time. More...
 
real a () const
 Return the amplitude.
 

Member Function Documentation

real gmx::anonymous_namespace{electricfield.cpp}::ElectricFieldDimension::evaluate ( real  t) const
inline

Evaluates this field component at given time.

Parameters
[in]tThe time to evaluate at
Returns
The electric field

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