SinkMeta/meta Input Parameters

SPONGE 2.0 documentation: SinkMeta/meta Input Parameters.

Organized by GPT-6-Astra. SPONGE 2.0 is under active, iterative development; features, parameters, and documentation may change. Consult the GitHub repository’s docs and skills for the latest version information.

Source snapshot for this page.

SinkMeta/meta Input Parameters

This list is derived from META::Initial() in SPONGE/bias/sinkmeta/config/config.cpp and default values in SPONGE/bias/sinkmeta/meta.h.

Parameters (module: meta)

ParameterType / ShapeRequiredDefault (if any)Meaning / Notes
CVstring listYesNoneCV module names used by Meta; determines dimensionality. If missing, META is not initialized.
dipfloatNo0.0Extra dip term for submarine/sink behavior (adds to bias shift via kB*T).
welltemp_factorfloatNo1e9Well-tempered bias factor; if > 1 enables well-tempered mode.
NdimintNoCV countExplicit dimensionality; must match CV list length.
subhillflagNofalseEnable sub-hill (Gaussian) behavior. Presence-only (no value read).
kdeintNo0Nonzero enables KDE mode and also sets subhill=true. Also switches sigma scaling to 1.414/sigma.
maskintNo0Enable mask mode (n-dim area exit label).
maxforcefloatNo0.1Edge force criterion for exit label; only read when mask is set.
sinkintNo0Nonzero enables negative-hill (sink/submarine) behavior.
sumhill_freqintNo0History frequency for sumhill accumulation (affects Rbias/RCT).
convmetaintNo0ConvolutionMeta flag; also sets do_negative=true.
grwintNo0GRW flag; also sets do_negative=true.
CV_periodfloat array (ndim)YesNone in METAPeriodic box length per CV. Always requested in META::Initial().
CV_sigmafloat array (ndim)YesNone in METAGaussian width per CV (must be > 0). Stored internally as inverse sigma.
cutofffloat array (ndim)No3 * CV_sigmaNeighbor cutoff for lookup and border wall; if present enables do_cutoff.
potential_in_filestringNoNoneRead potential from file; if set, Read_Potential() is called (grid/scatter settings below are bypassed).
scatter_in_filestringNoNoneRead scatter potential from file; sets use_scatter=true, usegrid=false, and calls Read_Potential().
edge_in_filestringNosumhill.logEdge-effect cache file used by EdgeEffect(). If the file exists and matches the expected grid size, SinkMeta reads it directly; otherwise it regenerates and writes to the same path.
scatterintNo0Number of scatter points; if > 0 uses scatter points instead of grid.
CV_minimalfloat array (ndim)ConditionallyNone in METAGrid minimum per CV; required when not using potential_in_file or scatter_in_file.
CV_maximumfloat array (ndim)ConditionallyNone in METAGrid maximum per CV; must be > CV_minimal. Required when not using potential_in_file or scatter_in_file.
CV_gridint array (ndim)ConditionallyNone in METAGrid points per CV; must be > 1. Required when not using potential_in_file or scatter_in_file.
heightfloatNo1.0Initial hill height (height_0).
wall_heightfloatNoNoneEnables border wall and sets border_potential_height.
potential_out_filestringNoMeta_Potential.txtOutput file name for writing potential.
potential_update_intervalintNowrite_information_interval or 1000Step interval for writing potential; if <= 0 it is forced to 1000.

Parameters used from other modules / global

ParameterScopeType / ShapeRequiredDefault (if any)Meaning / Notes
CV_pointEach CV modulefloat array (scatter size)ConditionallyNone in METAScatter point coordinates per CV; read only when scatter > 0.
write_information_intervalControllerintNo1000Global controller interval; used as default for potential_update_interval.

Notes

  • If both potential_in_file and scatter_in_file are present, potential_in_file takes precedence (the code uses if/else if).
  • CV_sigma is inverted internally; kde mode uses 1.414 / sigma, otherwise 1.0 / sigma.
  • Default file names set in code: read_potential_file_name and write_potential_file_name both start as Meta_Potential.txt.