北京科学智能研究院用户2292
ABACUS formatter库使用说明书
输入“/”快速插入内容
ABACUS formatter库使用说明书
ABACUS formatter库使用说明书
用户909用户9092023年10月19日修改
前言
目前相关issue：#2579、#2601、#2606。
formatter命名空间中模块基本结构
画板
模块基本使用方法示例
Fmt（原Formatter类）
Fmt类通过stream（流运算）方法实现单个字符的格式化输出（return到std::string对象），支持int, double和std::string数据类型。
使用方法
代码块
// width|precision|fill|left|scientific|if add '+'
formatter::Fmt formatter(4, 2, ' ', true,true, true);
std::cout<<formatter.format(1.2345)<<std::endl;
std::string astring = "hello";
std::cout<<formatter.format(astring)<<std::endl;
得到
代码块
+1.23
hello
画板
相应的setter和getter函数均已实现。
PhysicalFmt
基于对输出文件中具体物理量的考量，实际上我们并不需要无限多种有效数字位数、宽度等格式，即实际需要的格式有限，但每次设定width_、precision_、left_、error_、fillChar_操作较为繁琐，因此考虑建立基于物理量的封装，即PhysicalFmt。
使用方法
代码块
formatter::Fmt formatter;
formatter::PhysicalFmt phys_fmt("energy", &(formatter));
std::cout<<formatter.format(1.2345)<<std::endl;
phys_fmt.set_context("mass");
std::cout<<formatter.format(1.2345)<<std::endl;
我们首先创建了空的Fmt对象，之后使用PhysicalFmt类对象和其进行绑定。初始化PhysicalFmt对象时可以设置物理量的情景。我们首先设置为energy，进行一次输出，之后update为mass（即set_context），再次进行输出，得到：
代码块
1.2345000000
1.23
可扩展性
在整个formatter工具的设计之初，便考虑到对于扩展性的需求：现有代码中对保留位数，即数据格式化转换为字符串的考虑case可能是不够的，一方面可以增加功能让用户控制保留位数，另一方面则可以增加多种case的定义。基于这两点考虑，PhysicalFmt在进行扩展时仅仅需要修改一处，即PhysicalFmt::adjust_format()函数。
使用性扩展
其中一个思路是让用户控制输出文件中部分物理量的保留位数，可以通过修改PhysicalFmt::adjust()的某个判断分支中具体实参来实现，举例若INPUT文件中具有参数precision_energy，则该量经Input::Read()导入Input对象，然后被Input_conv::Convert()复制至GlobalV namespace，则设其对应于变量GlobalV::precision_ener，可以修改adjust_format()函数为：
代码块
void formatter::PhysicalFmt::adjust_formatter(bool left) {
auto context = this->context_.c_str();
....
else if (
(strcmp(context, "double_w20_f10") == 0)
....
||(strcmp(context, "energy") == 0)
) {
this->p_formatter_->set_width(20);
this->p_formatter_->set_precision(GlobalV::precision_ener);
this->p_formatter_->set_fillChar(' ');
this->p_formatter_->set_fixed(true);
this->p_formatter_->set_right(!left);
}