draft1-050515 #2
Conversation
|
Passive voice -- you seem to have caught the zombie virus of technical writing. "an unsteady panel method is implemented…" by zombies Check out my tweet: Try, as an exercise, to go over your text and find all the instances of passive voice, and ask yourself if you could say the same thing without that construct. For example, if I were to rewrite your first paragraph, I might go for something like this: "Capturing wake effects in an unsteady motion in the framework of potential flow requires that we use unsteady panel methods. We can set up a numerical experiment using a flat plate that starts moving in an imposed trajectory. To describe an infinitely thin lifting surface, panel methods use a series of discrete vortices, or a vortex sheet. We can also add sources to include the effect of thickness, but that will be outside the scope of this project." Notice how the passage above uses the left-to-right, natural order of subject/verb/object. Notice the verbs: capturing, requires, use, set up, moving, add, include, will be. You should try to write so that it is always clear who does what. In cell [1], you input a your helper functions, but your notebook doesn't tell us what's in there. It would be nice if you told your reader what you provide in that Python file. Reading the source, I count nine functions ... only two of them have docstrings, though. It's good practice to always include docstrings: they are better than comments, because the user can type help and get that documentation without reading the source code! In your results, there are two images that are not rendered in the nbviewer. In the raw file, I see that you are loading the images in markdown like this:
Try using HTML tags instead, like this:
(changing the width to whatever you like, in pixels) "It shows good agreement with the literature …" —> What literature? Can you give the specific source that you compared with? "The jump from constant circulation to a parabolic type of curve in the literature figure is the point that the flat plat experiences the sudden change in angle of attack."—> What? Finally, I would like to see your submission show a fully executed notebook, not the results as an embedded image from what looks like a screenshot. You included in the notebook a few code cells, but you don't explain what they are doing. I see your call to Typos, grammar, etc.: "The resulted flow field …"—> resulting |
|
Prof. Barba, Thank you very much for the comments. All those people that promised me to proof-read my writing, has not provide me so much insights about my writing style or choice of words. I'll try to rewrite my stuff in a tone of natural order. It really sounds different. |
2 participants
Hi Prof. Barba,
I was just able to work out a draft of my project, which is to simulate the wake of a flat plate after suddenly changing a small angle of attack. I apologize for any typos as I will continue reviewing it. A visual validation of the rolling up starting vortex and an animation is produced at the result section. I'm wondering if you could take a look and give me some feedback.
Sincerely,
Jingjing