Action_Thermostats
Add_AtomRandomPerturbation
Add_FitFragmentPartialChargesAction
Add_RotateAroundBondAction
Add_SelectAtomByNameAction
Added_ParseSaveFragmentResults
AddingActions_SaveParseParticleParameters
Adding_Graph_to_ChangeBondActions
Adding_MD_integration_tests
Adding_ParticleName_to_Atom
Adding_StructOpt_integration_tests
AtomFragments
Automaking_mpqc_open
AutomationFragmentation_failures
Candidate_v1.5.4
Candidate_v1.6.0
Candidate_v1.6.1
ChangeBugEmailaddress
ChangingTestPorts
ChemicalSpaceEvaluator
CombiningParticlePotentialParsing
Combining_Subpackages
Debian_Package_split
Debian_package_split_molecuildergui_only
Disabling_MemDebug
Docu_Python_wait
EmpiricalPotential_contain_HomologyGraph
EmpiricalPotential_contain_HomologyGraph_documentation
Enable_parallel_make_install
Enhance_userguide
Enhanced_StructuralOptimization
Enhanced_StructuralOptimization_continued
Example_ManyWaysToTranslateAtom
Exclude_Hydrogens_annealWithBondGraph
FitPartialCharges_GlobalError
Fix_BoundInBox_CenterInBox_MoleculeActions
Fix_ChargeSampling_PBC
Fix_ChronosMutex
Fix_FitPartialCharges
Fix_FitPotential_needs_atomicnumbers
Fix_ForceAnnealing
Fix_IndependentFragmentGrids
Fix_ParseParticles
Fix_ParseParticles_split_forward_backward_Actions
Fix_PopActions
Fix_QtFragmentList_sorted_selection
Fix_Restrictedkeyset_FragmentMolecule
Fix_StatusMsg
Fix_StepWorldTime_single_argument
Fix_Verbose_Codepatterns
Fix_fitting_potentials
Fixes
ForceAnnealing_goodresults
ForceAnnealing_oldresults
ForceAnnealing_tocheck
ForceAnnealing_with_BondGraph
ForceAnnealing_with_BondGraph_continued
ForceAnnealing_with_BondGraph_continued_betteresults
ForceAnnealing_with_BondGraph_contraction-expansion
FragmentAction_writes_AtomFragments
FragmentMolecule_checks_bonddegrees
GeometryObjects
Gui_Fixes
Gui_displays_atomic_force_velocity
ImplicitCharges
IndependentFragmentGrids
IndependentFragmentGrids_IndividualZeroInstances
IndependentFragmentGrids_IntegrationTest
IndependentFragmentGrids_Sole_NN_Calculation
JobMarket_RobustOnKillsSegFaults
JobMarket_StableWorkerPool
JobMarket_unresolvable_hostname_fix
MoreRobust_FragmentAutomation
ODR_violation_mpqc_open
PartialCharges_OrthogonalSummation
PdbParser_setsAtomName
PythonUI_with_named_parameters
QtGui_reactivate_TimeChanged_changes
Recreated_GuiChecks
Rewrite_FitPartialCharges
RotateToPrincipalAxisSystem_UndoRedo
SaturateAtoms_findBestMatching
SaturateAtoms_singleDegree
StoppableMakroAction
Subpackage_CodePatterns
Subpackage_JobMarket
Subpackage_LinearAlgebra
Subpackage_levmar
Subpackage_mpqc_open
Subpackage_vmg
Switchable_LogView
ThirdParty_MPQC_rebuilt_buildsystem
TrajectoryDependenant_MaxOrder
TremoloParser_IncreasedPrecision
TremoloParser_MultipleTimesteps
TremoloParser_setsAtomName
Ubuntu_1604_changes
stable
|
Last change
on this file since cae614 was caece4, checked in by Frederik Heber <heber@…>, 11 years ago |
|
Enhanced documentation significantly.
- went through all of the constructs and updated each.
- enhanced documentation ofr Fragmentation::FragmentMolecule().
|
-
Property mode
set to
100644
|
|
File size:
1.4 KB
|
| Line | |
|---|
| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file validators.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Jan 20, 2013
|
|---|
| 12 | * Author: ankele
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 | /** \page validators Validators
|
|---|
| 17 | *
|
|---|
| 18 | * Validators define constraints for variables. A given variable can be
|
|---|
| 19 | * tested whether or not it fulfills the constraints by executing the
|
|---|
| 20 | * validator's isValid() function. Equivalently the Validator::operator()
|
|---|
| 21 | * can be used.
|
|---|
| 22 | *
|
|---|
| 23 | * Their main purpose is to constrain user input for \ref parameters in \ref actions.
|
|---|
| 24 | *
|
|---|
| 25 | * There are several general purpose validators, for example:
|
|---|
| 26 | * - DummyValidator (no constraint)
|
|---|
| 27 | * - DiscreteValidator (is the variable element of a given set)
|
|---|
| 28 | * - RangeValidator (is the variable inside a halfopen interval)
|
|---|
| 29 | * - STLVectorValidator (defines a constraint for each element and/or for the number of elements)
|
|---|
| 30 | *
|
|---|
| 31 | * Validators can also be joined via and/or/not operations:
|
|---|
| 32 | * \code
|
|---|
| 33 | * RealSpaceMatrixSymmetricValidator() && RealSpaceMatrixInvertibleValidator()
|
|---|
| 34 | * \endcode
|
|---|
| 35 | *
|
|---|
| 36 | * The type of the variable is static. The base class Validator has a template
|
|---|
| 37 | * parameter to define the type. Some derived validators don't have template
|
|---|
| 38 | * parameters because they are derived from a Validator<SomeFixedType>.
|
|---|
| 39 | *
|
|---|
| 40 | * \date 2013-01-28
|
|---|
| 41 | *
|
|---|
| 42 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
