represent a keyword in the input More...

Data Fields
integer	ref_count = 0

character(len=default_string_length), dimension(:), pointer	names => NULL()

character(len=usage_string_length)	location = ""

character(len=usage_string_length)	usage = ""

character, dimension(:), pointer	description => null()

character(len=:), allocatable	deprecation_notice

integer, dimension(:), pointer	citations => NULL()

integer	type_of_var = 0

integer	n_var = 0

logical	repeats = .FALSE.

logical	removed = .FALSE.

type(enumeration_type), pointer	enum => NULL()

type(cp_unit_type), pointer	unit => NULL()

type(val_type), pointer	default_value => NULL()

type(val_type), pointer	lone_keyword_value => NULL()

Detailed Description

represent a keyword in the input

Parameters

names	the names of the current keyword (at least one should be present) for example "MAXSCF"
location	is where in the source code (file and line) the keyword is created
usage	how to use it "MAXSCF 10"
description	what does it do: "MAXSCF : determines the maximum number of steps in an SCF run"
deprecation_notice	show this warning that the keyword is deprecated
citations	references to literature associated with this keyword
type_of_var	the type of keyword (controls how it is parsed) it can be one of: no_parse_t,logical_t, integer_t, real_t, char_t
n_var	number of values that should be parsed (-1=unknown)
repeats	if the keyword can be present more than once in the section
removed	to trigger a CPABORT when encountered while parsing the input
enum	enumeration that defines the mapping between integers and strings
unit	the default unit this keyword is read in (to automatically convert to the internal cp2k units during parsing)
default_value	the default value for the keyword
lone_keyword_value	value to be used in presence of the keyword without any parameter

Note: I have expressely avoided a format string for the type of keywords: they should easily map to basic types of fortran, if you need more information use a subsection. [fawzi]

Author: Joost & fawzi

Definition at line 88 of file input_keyword_types.F.

Field Documentation

◆ ref_count

integer input_keyword_types::keyword_type::ref_count = 0

Definition at line 89 of file input_keyword_types.F.

◆ names

character(len=default_string_length), dimension(:), pointer input_keyword_types::keyword_type::names => NULL()

Definition at line 90 of file input_keyword_types.F.

◆ location

character(len=usage_string_length) input_keyword_types::keyword_type::location = ""

Definition at line 91 of file input_keyword_types.F.

◆ usage

character(len=usage_string_length) input_keyword_types::keyword_type::usage = ""

Definition at line 92 of file input_keyword_types.F.

◆ description

character, dimension(:), pointer input_keyword_types::keyword_type::description => null()

Definition at line 93 of file input_keyword_types.F.

◆ deprecation_notice

character(len=:), allocatable input_keyword_types::keyword_type::deprecation_notice

Definition at line 94 of file input_keyword_types.F.

◆ citations

integer, dimension(:), pointer input_keyword_types::keyword_type::citations => NULL()

Definition at line 95 of file input_keyword_types.F.

◆ type_of_var

integer input_keyword_types::keyword_type::type_of_var = 0

Definition at line 96 of file input_keyword_types.F.

◆ n_var

integer input_keyword_types::keyword_type::n_var = 0

Definition at line 96 of file input_keyword_types.F.

◆ repeats

logical input_keyword_types::keyword_type::repeats = .FALSE.

Definition at line 97 of file input_keyword_types.F.

◆ removed

logical input_keyword_types::keyword_type::removed = .FALSE.

Definition at line 97 of file input_keyword_types.F.

◆ enum

type(enumeration_type), pointer input_keyword_types::keyword_type::enum => NULL()

Definition at line 98 of file input_keyword_types.F.

◆ unit

type(cp_unit_type), pointer input_keyword_types::keyword_type::unit => NULL()

Definition at line 99 of file input_keyword_types.F.

◆ default_value

type(val_type), pointer input_keyword_types::keyword_type::default_value => NULL()

Definition at line 100 of file input_keyword_types.F.

◆ lone_keyword_value

type(val_type), pointer input_keyword_types::keyword_type::lone_keyword_value => NULL()

Definition at line 101 of file input_keyword_types.F.

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

input/input_keyword_types.F

Data Fields